diff --git a/docs/Makefile.am b/docs/Makefile.am index d45c36e..79d176c 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,11 +1,12 @@ ## Process this file with automake to produce Makefile.in -man_MANS = lcdproc.1 lcdexec.1 LCDd.8 lcdproc-config.5 +man_MANS = lcdproc.1 lcdexec.1 lcdvc.1 LCDd.8 lcdproc-config.5 SUBDIRS = lcdproc-user lcdproc-dev doxygen_input = header.html footer.html EXTRA_DIST = lcdproc.1.in \ lcdexec.1 \ + lcdvc.1.in \ LCDd.8.in \ lcdproc-config.5.in \ $(doxygen_input) @@ -18,11 +19,14 @@ LCDd.8: LCDd.8.in lcdproc.1: lcdproc.1.in sed -e 's:@SYSCONFDIR@:@sysconfdir@:g' $? > $@ +lcdvc.1: lcdvc.1.in + sed -e 's:@SYSCONFDIR@:@sysconfdir@:g' $? > $@ + lcdproc-config.5: lcdproc-config.5.in sed -e 's:@SYSCONFDIR@:@sysconfdir@:g' $? > $@ ## clean generated makefiles -CLEANFILES = LCDd.8 lcdproc.1 lcdproc-config.5 +CLEANFILES = LCDd.8 lcdproc.1 lcdvc.1 lcdproc-config.5 ## convenience targets diff --git a/docs/lcdvc.1.in b/docs/lcdvc.1.in new file mode 100644 index 0000000..fb4da85 --- /dev/null +++ b/docs/lcdvc.1.in @@ -0,0 +1,71 @@ +.\" This man page is released under the GNU General Public License. +.\" Refer to the COPYING file distributed with this package. +.TH "lcdvc" "1" "12 June 2009" "LCDproc" "LCDproc suite" +.SH "NAME" +.LP +lcdvc \- LCDproc virtual console +.SH "SYNOPSIS" +.LP +lcdvc +[\fB\-fh\fR] +[\fB\-a\fR \fIaddr\fR] +[\fB\-c\fR \fIfile\fR] +[\fB\-p\fR \fIport\fR] +[\fB\-r\fR \fIlevel\fR] +[\fB\-s\fR \fIbool\fR] +.SH "DESCRIPTION" +.LP +This program shows content from a system console on a LCD controlled by +\fBLCDd\fR. As the console is usually larger than a LCD, the area shown on +the LCD screen can be scrolled using keys attached to the display. +.LP +Additionally it features an autoscroll feature, which is on by default and can +only be disabled by using \fBlcdvc\fR's menu. +.LP +By default it uses \fI/dev/vcs\fR and \fI/dev/vcsa\fR devices as the +console to show. Other console devices can be set in the configuration file +\fI@SYSCONFDIR@/lcdvc.conf\fR. The keys used for scrolling can be set in the config +file as well. +.SH "OPTIONS" +.LP +The following options can be set in the configuration file +\fI@SYSCONFDIR@/lcdvc.conf\fR as well, but those given on the command line take +precedence: +.TP +\fB\-a\fR \fIaddr\fR +DNS name or IP address of the LCDd server (default localhost). +.TP +\fB\-c\fR \fIfile\fR +Specify configuration file. +.TP +\fB\-f\fR +Run in foreground. +.TP +\fB\-h\fR +Output help and exit. +.TP +\fB\-p\fR \fIport\fR +Port of the LCDd server (default 13666). +.TP +\fB\-r\fR \fIlevel\fR +Set reporting level (0\-5, default: 2) +.TP +\fB\-s\fR \fIbool\fR +Report to syslog (1) or stderr (0, default). +.SH "FILES" +.LP +\fI@SYSCONFDIR@/lcdvc.conf\fP +.br +\fI/dev/vcs\fP +.br +\fI/dev/vcsa\fP +.SH "AUTHORS" +.LP +\fBlcdvc\fR was originally written by Joris Robijn, modified by Peter Marschall. +.LP +This man page was written by Markus Dolze. +.SH "SEE ALSO" +.LP +LCDd(8) vcs(4) +.SH "LICENSE" +\fBlcdvc\fR is released under the GNU General Public License, version 2.