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

Last change on this file since 3963 was 3963, checked in by Jean-Yves Lamoureux, 11 years ago
  • Added documentation to lock_timeout command line switch
File size: 2.8 KB
Line 
1.TH neercs 1 "2009-11-10" "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.TP 5
33.B \-l \fR[ \fIseconds \fR]
34Lock screen after \fIseconds\fP seconds.
35.PP
36.SH KEYBINDINGS
37.PP
38Within \fBneercs\fR, some keybindings are reminded in the status bar,
39the complete list can be found in the help screen accessible with
40\fBCtrl-a h\fR.
41.PP
42All the actions are available through \fBCtrl-a \fIX\fR with \fIX\fR
43being one of the following:
44.TP
45.BR n " Next window"
46.TP
47.BR p " Previous window"
48.TP
49.BR w " Switch window manager"
50.TP
51.BR c " Create new window"
52.TP
53.BR m " Show/Hide Thumbnails"
54.TP
55.BR d " Detach"
56.TP
57.BR k " Close current window and kill associated process"
58.TP
59.BR h " Display help"
60
61.SH CONFIGURATION FILE
62The configuration file contains one setting per line in the form
63\fIname\fR=\fIvalue\fR.
64.PP
65When a setting appears several times, last occurrence only is used.
66.PP
67When a setting as type \fIbool\fR, it will be true if the value is 1
68or \fItrue\fR, false for any other value.
69.PP
70Valid settings are the following:
71.TP 5
72.BI window_manager= full|hsplit|vsplit|card
73Use given window manager, default is vsplit.
74.TP 5
75.BI thumbnails= bool
76Display thumbnails.
77.TP 5
78.BI status_bar= bool
79Display status bar.
80.TP 5
81.BI cube_duration= n
82Cube rotation duration (while using 'cube' window manager)
83.TP 5
84.BI screensaver_timeout= n
85Start screensaver after \fIn\fR seconds of inactivity.
86.TP 5
87.BI autolock_timeout= n
88Lock screen after \fIn\fR seconds of inactivity.
89.TP 5
90.BI lock_on_detach= bool
91.Lock screen when detaching.
92.TP 5
93.BI socket_dir= dir
94Store sockets in \fIdir\fP. Default location is taken from
95\fBNEERCSDIR\fR environment variable if defined, or \fBTMPDIR\fR.
96If this option is not set and none of these variables is defined,
97\fI/tmp\fR will be used.
98.TP 5
99.BI delay= n
100Wait at least \fIn\fRms between refresh.
101.SH EXAMPLES
102.PP
103neercs top cacademo zsh
104.SH SEE ALSO
105.PP
106\fBscreen(1)\fR
107.SH AUTHOR
108This manual page was written by Jean-Yves Lamoureux
109<jylam@lnxscene.org> and updated by Pascal Terjan <pterjan@linuxfr.org>
Note: See TracBrowser for help on using the repository browser.