Changeset 3436Tweet

Timestamp:

05/12/09 11:17:13 (4 years ago)

Author:

pterjan

Message:

• Add command line options and config file syntax to the manpage

File:

• neercs/trunk/doc/neercs.1 (modified) (3 diffs)

neercs/trunk/doc/neercs.1

@@ -1 @@
-.TH neercs 1 "2008-06-20" "neercs"
+.TH neercs 1 "2009-05-12" "neercs"
 .SH NAME
 neercs \- text-mode window manager
 .SH SYNOPSIS
-\fBneercs\fR [\fIPROGRAM1\fR \fIPROGRAM2...]
+\fBneercs\fR [\fIOPTIONS\fR] [\fIPROGRAM1\fR \fIPROGRAM2\fR...]
 .SH DESCRIPTION
 .PP
@@ -11 +11 @@
 ($SHELL environment variable).
 .PP
-\fBneercs\fR will search for a configuration file called /etc/neercs.conf, then \fB.neercsrc\fR in
-your home directory (in that order).
+.SH "COMMAND-LINE OPTIONS"
+.PP
+\fBneercs\fR has the following command-line options:
+.TP 5
+.BI "\-c " file
+override the default configuration file to \fIfile\fP. Default is to try
+\*Q/etc/neercs.conf\*U and \*Q$HOME/.neercsrc\*U.
+.TP 5
+.BI "\-P " pid 
+Grab a running process.
+.TP 5
+.B \-r \fR[ \fIsession \fR]
+Reattach a session.
+.TP 5
+.B \-R \fR[ \fIsession \fR]
+Reattach a session if possible, otherwise start a new session.
+.TP 5
+.BI "\-S " name
+Name the session \fIname\fP instead of using the pid.
+.PP
+.SH CONFIGURATION FILE
+The configuration file contains one setting per line in the form
+\fIname\fR=\fIvalue\fR.
+.PP
+When a setting appears several times, last occurrence only is used.
+.PP
+When a setting as type \fIbool\fR, it will be true if the value is 1
+or \fItrue\fR, false for any other value.
+.PP
+Valid settings are the following:
+.TP 5
+.BI window_manager= full|hsplit|vsplit|card
+Use given window manager, default is vsplit.
+.TP 5
+.BI thumbnails= bool
+Display thumbnails.
+.TP 5
+.BI status_bar= bool
+Display status bar.
+.TP 5
+.BI screensaver_timeout= n
+Start screensaver after \fIn\fR seconds of inactivity.
+.TP 5
+.BI autolock_timeout= n
+Lock screen after \fIn\fR seconds of inactivity.
+.TP 5
+.BI socket_dir= dir
+Store sockets in \fIdir\fP. Default location is taken from
+\fBNEERCSDIR\fR environment variable if defined, or \fBTMPDIR\fR.
+If this option is not set and none of these variables is defined,
+\fI/tmp\fR will be used.
 .SH EXAMPLES
 .PP
@@ -20 +69 @@
 \fBscreen(1)\fR
 .SH AUTHOR
-This manual page was written by Jean-Yves Lamoureux <jylam@lnxscene.org>
+This manual page was written by Jean-Yves Lamoureux
+<jylam@lnxscene.org> and updated by Pascal Terjan <pterjan@linuxfr.org>