| 1 | .TH neercs 1 "2009-11-10" "neercs" |
|---|
| 2 | .SH NAME |
|---|
| 3 | neercs \- 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 |
|---|
| 10 | If 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 |
|---|
| 18 | override 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 |
|---|
| 22 | Grab a running process. |
|---|
| 23 | .TP 5 |
|---|
| 24 | .B \-r \fR[ \fIsession \fR] |
|---|
| 25 | Reattach a session. |
|---|
| 26 | .TP 5 |
|---|
| 27 | .B \-R \fR[ \fIsession \fR] |
|---|
| 28 | Reattach a session if possible, otherwise start a new session. |
|---|
| 29 | .TP 5 |
|---|
| 30 | .BI "\-S " name |
|---|
| 31 | Name the session \fIname\fP instead of using the pid. |
|---|
| 32 | .PP |
|---|
| 33 | .SH KEYBINDINGS |
|---|
| 34 | .PP |
|---|
| 35 | Within \fBneercs\fR, some keybindings are reminded in the status bar, |
|---|
| 36 | the complete list can be found in the help screen accessible with |
|---|
| 37 | \fBCtrl-a h\fR. |
|---|
| 38 | .PP |
|---|
| 39 | All the actions are available through \fBCtrl-a \fIX\fR with \fIX\fR |
|---|
| 40 | being one of the following: |
|---|
| 41 | .TP |
|---|
| 42 | .BR n " Next window" |
|---|
| 43 | .TP |
|---|
| 44 | .BR p " Previous window" |
|---|
| 45 | .TP |
|---|
| 46 | .BR w " Switch window manager" |
|---|
| 47 | .TP |
|---|
| 48 | .BR c " Create new window" |
|---|
| 49 | .TP |
|---|
| 50 | .BR m " Show/Hide Thumbnails" |
|---|
| 51 | .TP |
|---|
| 52 | .BR d " Detach" |
|---|
| 53 | .TP |
|---|
| 54 | .BR k " Close current window and kill associated process" |
|---|
| 55 | .TP |
|---|
| 56 | .BR h " Display help" |
|---|
| 57 | |
|---|
| 58 | .SH CONFIGURATION FILE |
|---|
| 59 | The configuration file contains one setting per line in the form |
|---|
| 60 | \fIname\fR=\fIvalue\fR. |
|---|
| 61 | .PP |
|---|
| 62 | When a setting appears several times, last occurrence only is used. |
|---|
| 63 | .PP |
|---|
| 64 | When a setting as type \fIbool\fR, it will be true if the value is 1 |
|---|
| 65 | or \fItrue\fR, false for any other value. |
|---|
| 66 | .PP |
|---|
| 67 | Valid settings are the following: |
|---|
| 68 | .TP 5 |
|---|
| 69 | .BI window_manager= full|hsplit|vsplit|card |
|---|
| 70 | Use given window manager, default is vsplit. |
|---|
| 71 | .TP 5 |
|---|
| 72 | .BI thumbnails= bool |
|---|
| 73 | Display thumbnails. |
|---|
| 74 | .TP 5 |
|---|
| 75 | .BI status_bar= bool |
|---|
| 76 | Display status bar. |
|---|
| 77 | .TP 5 |
|---|
| 78 | .BI screensaver_timeout= n |
|---|
| 79 | Start screensaver after \fIn\fR seconds of inactivity. |
|---|
| 80 | .TP 5 |
|---|
| 81 | .BI autolock_timeout= n |
|---|
| 82 | Lock screen after \fIn\fR seconds of inactivity. |
|---|
| 83 | .TP 5 |
|---|
| 84 | .BI lock_on_detach= bool |
|---|
| 85 | .Lock screen when detaching. |
|---|
| 86 | .TP 5 |
|---|
| 87 | .BI socket_dir= dir |
|---|
| 88 | Store sockets in \fIdir\fP. Default location is taken from |
|---|
| 89 | \fBNEERCSDIR\fR environment variable if defined, or \fBTMPDIR\fR. |
|---|
| 90 | If this option is not set and none of these variables is defined, |
|---|
| 91 | \fI/tmp\fR will be used. |
|---|
| 92 | .TP 5 |
|---|
| 93 | .BI delay= n |
|---|
| 94 | Wait at least \fIn\fRms between refresh. |
|---|
| 95 | .SH EXAMPLES |
|---|
| 96 | .PP |
|---|
| 97 | neercs top cacademo zsh |
|---|
| 98 | .SH SEE ALSO |
|---|
| 99 | .PP |
|---|
| 100 | \fBscreen(1)\fR |
|---|
| 101 | .SH AUTHOR |
|---|
| 102 | This manual page was written by Jean-Yves Lamoureux |
|---|
| 103 | <jylam@lnxscene.org> and updated by Pascal Terjan <pterjan@linuxfr.org> |
|---|
