freerdp-shadow-cli(1)

💖 freerdp-shadow-cli — a utility for sharing a X display via RDP 💖

okay so bestie, welcome to the freerdp-shadow-cli(1) page, part of the FreeRDP manual 💅. this is the little command that lets you share a running X display over RDP instead of VNC, and honestly? iconic.

---

✨ SYNOPSIS ✨

freerdp-shadow-cli [/port:<port number>] [/ipc-socket:<ipc-socket>]
[/monitors:<0,1,2,...>] [/rect:<x,y,w,h>] [+auth] [-may-view] [-may-
interact] [/sec:<rdp|tls|nla|ext>] [-sec-rdp] [-sec-tls] [-sec-nla]
[-sec-ext] [/sam-file:<file>] [/version] [/help]

---

🌸 DESCRIPTION 🌸

freerdp-shadow-cli lets you share a running X display like with VNC but by using the RDP instead 🦋. and yes, you can also share only parts (rect) of the display, not me being fancy 💅. no cap.

---

🎀 OPTIONS 🎀

• /ipc-socket:<ipc-socket> — if you set this option, an ipc socket with the path ipc-socket is used instead of a TCP socket ✨.
• /port:<port> — sets the port to use. default is 3389. this option is ignored if ipc-socket is used, so don't come crying to me 😭.
• /monitors:<1,2,3,...> — pick which monitor(s) to share 👑.
• /rect:<x,y,w,h> — pick a rectangle within the monitor to share 🌸.
• -auth — disable authentication. if authentication is enabled, PAM is used with the X11 subsystem. running as root is not necessary, however if run as user only the same user that started freerdp-shadow-cli can authenticate 🫶.

⚠️ Warning: if authentication is disabled, everyone can connect. like, everyone everyone. bestie. pls be careful 💀.

• -may-view — clients may view without prompt 👀.
• -may-interact — clients may interact without prompt 🖱️.
• /sec:<rdp|tls|nla|ext> — force a specific protocol security 🔐.
• -sec-rdp — disable RDP security (default: on) 💜.
• -sec-tls — disable TLS protocol security (default: on) 💜.
• -sec-nla — disable NLA protocol security (default: on) 💜.
• +sec-ext — use NLA extended protocol security (default: off) 🌈.
• /sam-file:<file> — NTLM SAM file for NLA authentication 🗂️.
• /version — print the version and exit. short and sweet ✨.
• /help — print the help and exit. we love a helpful icon 💅.

---

🌟 USAGE 🌟

• #MANPAGE_NAME@ - start the shadow server on port 3389 with NLA security, SAM database at /etc/winpr/SAM
• freerdp-shadow-cli /sam-file:SAM.db - same as above, but a custom SAM database provided as argument
• freerdp-shadow-cli -sec-nla - start the shadow server on port 3380 with TLS/NLA security. This allows authenticating against PAM with unix users. Be aware that the password is transmitted plain text like with basic HTTP auth 😭

---

🦋 EXAMPLES 🦋

freerdp-shadow-cli /port:12345

when run as user within a X session (for example from an xterm) a socket on 12345 is opened and the current display is shared via RDP ✨. slay.

---

💜 EXIT STATUS 💜

• 0 — successful program execution. we ate 🍓
• 1 — otherwise. it's giving not-slaying 😭

---

🌈 SEE ALSO 🌈

freerdp(7) wlog(7)

---

👑 AUTHOR 👑

FreeRDP <team@freerdp.com>

---

okay that's the whole page bestie, you're officially a shadow-server main character now 💅✨. this was freerdp-shadow-cli(1) from FreeRDP version 3.32.1, dated 2017-01-12 — go share that display, ily 🫶🎀