vgd.1.in

.TH VGD 1 "@RELEASE_DATE@" "" "Viewglob Manual (vgd)"
.SH NAME
vgd \- Viewglob communication daemon.
.SH SYNOPSIS
.B vgd
.RI [ options ]

.SH DESCRIPTION
\fIvgd\fP acts as a mediator between any number of
.BR vgseer (1)
processes and a single Viewglob display process (which it controls).  It keeps track of the active terminal and passes information from the corresponding vgseer (if there is one) to the display.
.PP
While vgseer can be used on a remote machine using ssh or telnet, it only makes sense for vgd to be running on the same X server as the user (meaning, in most cases, locally).
.PP
After successful startup, vgd uses the syslog interface for error reporting if running as a daemon.
.PP
This program is slightly misnamed; traditionally, a single daemon process provides a service on a machine for all users.  In Viewglob's case, there should be separate vgd processes for each physical user running Viewglob.  The \fIviewglob\fP startup script handles this automatically, and is recommended for simple usage.

.SH OPTIONS
This program follows the usual GNU command line syntax, with long options starting with two dashes.  A summary is included below.
.TP
.B \-p, \-\-port=<number>
Listen on the given port.  The default is 16108 (1\-GLOB).
.TP
.B \-P, \-\-persistent=<on/off>
Keep vgd around even after all vgseers have disconnected.  It will sit and listen for new connections instead of exiting.  Persistence is off by default.
.TP
.B \-D, \-\-daemon=<on/off>
Run vgd as a daemon (it relinquishes its terminal).  vgd runs as a daemon by default.
.TP
.B \-d, \-\-display=<vgclassic|vgmini|[path]>
Display program.  The Viewglob package comes with \fIvgclassic\fP and \fIvgmini\fP (the new display).  Though there aren't any other displays in existence at this point, one could be used by passing its path.  The default is vgmini.
.TP
.B \-s, \-\-sort\-style=<windows|ls>
In the display, sort files with directories first (Windows) or purely by name (ls).  ls mode is the default.
.TP
.B \-r, \-\-dir\-order=<descending|ascending|ascending\-pwd\-first>
In the display, list directories in descending order (the default), ascending (last referenced directory has the top listing), or ascending with the current directory always first.
.TP
.B \-i, \-\-file\-icons=<on/off>
Show or hide the file type icons in the display.
.TP
.B \-j, \-\-jump\-resize=<on/off>
Enable or disable the automatic moving+resizing feature of vgmini.
.TP
.B \-z, \-\-font\-size\-modifier=<+/\-##>
Increase or decrease the base font size in the display by the given number.  E.g. \*(lq\-z +2\*(rq increases the window manager's default by 2, while \*(lq\-z \-2\*(rq decreases the default by 2.
.PP
.B \-\-black=<colour>
.br
.B \-\-red=<colour>
.br
.B \-\-green=<colour>
.br
.B \-\-yellow=<colour>
.br
.B \-\-blue=<colour>
.br
.B \-\-magenta=<colour>
.br
.B \-\-cyan=<colour>
.br
.B \-\-white=<colour>
.br
.RS
Define the colours used for interpreting LS_COLORS as you would in an .Xdefaults file.  This means <colour> can be a name such as \*(lqDarkSlateGray\*(rq or a hex specification like #RRGGBB (quoted on the command line).  There are also other forms: see
.BR XParseColor (3)
for more information.  The defaults are easy to read on a light coloured background, but probably not suitable for a dark background.  For that case, these should be a good starting point (add to vgd.conf):
.IP
.RS
black     #000000
.br
red       #c11125
.br
green     #50881e
.br
yellow    #c4b400
.br
blue      #1662a2
.br
magenta   #ef709a
.br
cyan      #2ca3a4
.br
white     #ffffff
.RE
.RE
.TP
.B \-h, \-\-help
Show summary of options.
.TP
.B \-V, \-\-version
Show the version of the program.

.SH NOTES
vgd keeps track of the active terminal by querying the X server.  This doesn't work great for tabbed terminals such as \fIgnome\-terminal\fP and \fIkonsole\fP, because they share an X window.  With these, you will need to wake up vgd when you shuffle around.  If you switch to a shell and the display doesn't automatically update, send it the refocus command C\-g <TAB>.
.PP
By default vgmini is in jump/resize mode, which means it'll move to be near the active terminal and change its dimensions to try to match.  Some window managers just don't deal with this well and the resizing can get wacky.  If you're seeing this behaviour, you can disable jump/resize mode (or switch to a different window manager).

.SH FILES
.I ~/.viewglob/vgd.conf
.IP
If present, this file specifies a default configuration for vgd.  The file syntax is:
.IP
<\fIlong_option_name\fP> [ <\fIwhitespace\fP> <\fIvalue\fP> ]
.IP
The '#' character can be used for comments.
.IP
So, to always listen on port 5555, run in persistent mode, and use a slightly smaller font than your window manager suggests, the file should contain:
.IP
.RS
.PD 0
.TP 22n
port
5555
.TP
persistent
on
.TP
font\-size\-modifier
\-1
.PD
.RE
.IP
Configuration file options can be overridden on the command line.
.PP
.I ~/.viewglob/.<port>
.IP
Each instance of vgd listens on both an Internet\-domain socket on the specified port, and a Unix\-domain socket named for that port.  Connection attempts on either socket are treated equivalently.

.SH "ENVIRONMENT VARIABLES"
.TP
.SM LS_COLORS
Used by the display as described in
.BR dir_colors (5).
.TP
If you encounter an issue where certain filenames do not show in the display and you are using an encoding other than UTF\-8, you may want to read about the GLib environment variables:
.IP
\fIhttp://developer.gnome.org/doc/API/2.0/glib/glib\-running.html\fP
.TP
For example, for iso8859\-1, run:
.IP
\fBG_FILENAME_ENCODING=ISO\-8859\-1 vgd\fP

.SH DIAGNOSTICS
.TP
Exit status is 0 if vgd daemonizes or exits successfully.  If vgd fails to obtain a connection to the X display, exit status is 3.  If a socket setup error occurs, exit status is 2.  For other errors, exit status is 1.
.SH AUTHORS
Stephen Bach <sjbach@users.sourceforge.net>
.SH SEE ALSO
.BR viewglob (1),
.BR vgseer (1),
.BR ls (1),
.BR dir_colors (5),
.BR XParseColor (3),
.br
.BR syslogd (8).