Changeset 3436 for neercs


Ignore:
Timestamp:
May 12, 2009, 11:17:13 AM (11 years ago)
Author:
Pascal Terjan
Message:
  • Add command line options and config file syntax to the manpage
File:
1 edited

Legend:

Unmodified
Added
Removed
  • neercs/trunk/doc/neercs.1

    r2484 r3436  
    1 .TH neercs 1 "2008-06-20" "neercs"
     1.TH neercs 1 "2009-05-12" "neercs"
    22.SH NAME
    33neercs \- text-mode window manager
    44.SH SYNOPSIS
    5 \fBneercs\fR [\fIPROGRAM1\fR \fIPROGRAM2...]
     5\fBneercs\fR [\fIOPTIONS\fR] [\fIPROGRAM1\fR \fIPROGRAM2\fR...]
    66.SH DESCRIPTION
    77.PP
     
    1111($SHELL environment variable).
    1212.PP
    13 \fBneercs\fR will search for a configuration file called /etc/neercs.conf, then \fB.neercsrc\fR in
    14 your home directory (in that order).
     13.SH "COMMAND-LINE OPTIONS"
     14.PP
     15\fBneercs\fR has the following command-line options:
     16.TP 5
     17.BI "\-c " file
     18override the default configuration file to \fIfile\fP. Default is to try
     19\*Q/etc/neercs.conf\*U and \*Q$HOME/.neercsrc\*U.
     20.TP 5
     21.BI "\-P " pid
     22Grab a running process.
     23.TP 5
     24.B \-r \fR[ \fIsession \fR]
     25Reattach a session.
     26.TP 5
     27.B \-R \fR[ \fIsession \fR]
     28Reattach a session if possible, otherwise start a new session.
     29.TP 5
     30.BI "\-S " name
     31Name the session \fIname\fP instead of using the pid.
     32.PP
     33.SH CONFIGURATION FILE
     34The configuration file contains one setting per line in the form
     35\fIname\fR=\fIvalue\fR.
     36.PP
     37When a setting appears several times, last occurrence only is used.
     38.PP
     39When a setting as type \fIbool\fR, it will be true if the value is 1
     40or \fItrue\fR, false for any other value.
     41.PP
     42Valid settings are the following:
     43.TP 5
     44.BI window_manager= full|hsplit|vsplit|card
     45Use given window manager, default is vsplit.
     46.TP 5
     47.BI thumbnails= bool
     48Display thumbnails.
     49.TP 5
     50.BI status_bar= bool
     51Display status bar.
     52.TP 5
     53.BI screensaver_timeout= n
     54Start screensaver after \fIn\fR seconds of inactivity.
     55.TP 5
     56.BI autolock_timeout= n
     57Lock screen after \fIn\fR seconds of inactivity.
     58.TP 5
     59.BI socket_dir= dir
     60Store sockets in \fIdir\fP. Default location is taken from
     61\fBNEERCSDIR\fR environment variable if defined, or \fBTMPDIR\fR.
     62If this option is not set and none of these variables is defined,
     63\fI/tmp\fR will be used.
    1564.SH EXAMPLES
    1665.PP
     
    2069\fBscreen(1)\fR
    2170.SH AUTHOR
    22 This manual page was written by Jean-Yves Lamoureux <jylam@lnxscene.org>
     71This manual page was written by Jean-Yves Lamoureux
     72<jylam@lnxscene.org> and updated by Pascal Terjan <pterjan@linuxfr.org>
Note: See TracChangeset for help on using the changeset viewer.