source: neercs/trunk/doc/neercs.1 @ 3436

Last change on this file since 3436 was 3436, checked in by Pascal Terjan, 12 years ago
  • Add command line options and config file syntax to the manpage
File size: 2.0 KB
Line 
1.TH neercs 1 "2009-05-12" "neercs"
2.SH NAME
3neercs \- text-mode window manager
4.SH SYNOPSIS
5\fBneercs\fR [\fIOPTIONS\fR] [\fIPROGRAM1\fR \fIPROGRAM2\fR...]
6.SH DESCRIPTION
7.PP
8\fBneercs\fR manages as many terminals as you want in the same window.
9.PP
10If no file arguments are provided, \fBneercs\fR will launch your default shell
11($SHELL environment variable).
12.PP
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.
64.SH EXAMPLES
65.PP
66neercs top cacademo zsh
67.SH SEE ALSO
68.PP
69\fBscreen(1)\fR
70.SH AUTHOR
71This manual page was written by Jean-Yves Lamoureux
72<jylam@lnxscene.org> and updated by Pascal Terjan <pterjan@linuxfr.org>
Note: See TracBrowser for help on using the repository browser.