tigervncconfig(1)

💖 tigervncconfig(1) — the Virtual Network Computing manual, bestie edition 💖

okay so before we even get into it: this is tigervncconfig, part of the TigerVNC suite, and it lives in section 1 of your manual pages. It's the little remote-control for a running VNC server and honestly? iconic. 🎀

---

✨ NAME ✨

tigervncconfig — configure and control a VNC server. that's it, that's the whole job. 💅

---

🦋 SYNOPSIS 🦋

tigervncconfig [parameters]
tigervncconfig [parameters] -connect [-view-only] host[:port]
tigervncconfig [parameters] -disconnect
tigervncconfig [parameters] [-set] Xtigervnc-param=value ...
tigervncconfig [parameters] -list
tigervncconfig [parameters] -get Xtigervnc-param
tigervncconfig [parameters] -desc Xtigervnc-param

---

🌸 DESCRIPTION 🌸

So tigervncconfig is how you configure and control a running instance of Xtigervnc, or literally any other X server that has the VNC extension. But heads up bestie — it can't control VNC servers from before version 4. no cap. 🚫

When you run it with no options at all, it just kind of chills there as a sort of "helper" application for Xtigervnc. Its whole main-character purpose in this mode is to ask the user how new connections should be handled — but only if that feature is enabled, okay? If you always want that query support but you do not want your desktop cluttered with the settings window, use the -nowin flag. Or, if you'd rather it just start all iconified and cute, there's the -iconic option for that. 🫶

When you run it in any other mode, tigervncconfig is a one-shot program — it does one thing and dips. It configures or controls Xtigervnc as appropriate. You can use it to tell Xtigervnc to connect to or disconnect from listening viewers, and to set and retrieve Xtigervnc's parameters. very multitasking of it. ✨

⚠️ real talk: the DISPLAY environment variable or the -display option must be set as appropriate to control Xtigervnc. And if you run this on an ordinary X server (or on a version 3 Xtigervnc), you're gonna get an error message saying there's no VNC extension. sorry bestie, it's just not there. 😭

---

💅 OPTIONS 💅

• -connect [-view-only] host[:port] — Tells an Xtigervnc server to make a "reverse" connection to a listening VNC viewer. (Normally it's the other way round — the viewer connects to the server, but we're flipping the script today. 🔄) host is where that listening viewer is running. If it's not listening on the default port of 5500, you can just say host:port instead. And the -view-only option means the server has to ignore all keyboard or mouse events sent by the client. no touching. 🙈
• -desc Xtigervnc-param — Prints a short description of the Xtigervnc parameter you asked about. like a little wiki lookup for your server. 📖
• -disconnect — Makes Xtigervnc disconnect from all viewers, so the VNC desktop isn't displayed anywhere anymore. gone. vanished. poof. 💀
• -get Xtigervnc-param — Prints the current value of the Xtigervnc parameter you named. 📋
• -list — Lists all the parameters supported by Xtigervnc. the whole roster, the full lineup. 👑
• [-set] Xtigervnc-param=value — Sets an Xtigervnc parameter to the value you give it. But ngl, some of Xtigervnc's parameters are read only once at startup, so changing them this way might not have any effect at all. 🥲 don't say nobody warned you.

---

🎀 PARAMETERS 🎀

Okay so plot twist: tigervncconfig has parameters of its own that you can set on the command line. Do not confuse these with Xtigervnc's parameters — those are the ones you mess with using the -set, -get, -list and -desc options. two different friend groups, don't mix them up. 🫶

Here's the grammar, bestie:

• turn a parameter on with -param
• turn it off with -param=0
• parameters that take a value: -param value
• other valid forms: param=value, -param=value, --param=value
• and parameter names are case-insensitive. slay. ✨

The actual parameters:

• -display Xdisplay — Specifies the Xtigervnc server to control. 🖥️
• -iconic — When run as a "helper" app, makes the window iconified at startup. smol window energy. 🌸
• -nowin — When run as a "helper" app, don't put up a window. zero windows, all vibes. 🧚

---

🌈 SEE ALSO 🌈

tigervncpasswd(1), xtigervncviewer(1), Xtigervnc(1), tigervncsession(8)

https://www.tigervnc.org

---

💜 AUTHOR 💜

Tristan Richardson, RealVNC Ltd. and others. 🫡

VNC was originally developed by the RealVNC team while they were at Olivetti Research Ltd / AT&T Laboratories Cambridge. The TightVNC additions were implemented by Constantin Kaplinsky. Many other people have since participated in development, testing and support. And this manual is part of the TigerVNC software suite. 💖

---

and that's the whole page, bestie!! 🦋 this one came from the TigerVNC crew, it's the tigervncconfig(1) page, and it's dated with that same footer energy as the original — go forth and configure responsibly. mwah. 💅✨💖