1 diff -Nru screen-3.9.8/doc/screen.texinfo screen-3.9.8.new/doc/screen.texinfo
2 --- screen-3.9.8/doc/screen.texinfo Thu Jul 6 15:41:22 2000
3 +++ screen-3.9.8.new/doc/screen.texinfo Mon Sep 18 01:52:51 2000
5 In all other cases @samp{-q} has no effect.
7 @item -r [@var{pid.sessionname}]
8 -@itemx -r @var{sessionowner/[pid.sessionname]}
9 +@itemx -r sessionowner/[@var{pid.sessionname}]
10 Resume a detached @code{screen} session. No other options (except
11 combinations with @samp{-d} or @samp{-D}) may be specified, though
14 Change a user's permissions. @xref{Multiuser Session}.
15 @item acldel @var{username}
16 Disallow other user in this session. @xref{Multiuser Session}.
17 -@item aclgrp @var{usrname [groupname]}
18 +@item aclgrp usrname [@var{groupname}]
19 Inherit permissions granted to a group leader. @xref{Multiuser Session}.
20 -@item aclumask @var{[users]+\-bits ...}
21 +@item aclumask [@var{users}]+\-bits ...
22 Predefine access to new windows. @xref{Umask}.
23 @item activity @var{message}
24 Set the activity notification message. @xref{Monitor}.
26 Synonym to @code{acladd}. @xref{Multiuser Session}.
27 @item allpartial @var{state}
28 Set all windows to partial refresh. @xref{Redisplay}.
29 -@item at @var{[ident][@kbd{#}@var{|}@kbd{*}@var{|}@kbd{%}] command [args]}
30 +@item at [@var{ident}][@kbd{#}@var{|}@kbd{*}@var{|}@kbd{%}] command [@var{args}]
31 Execute a command at other displays or windows. @xref{At}.
32 @item autodetach @var{state}
33 Automatically detach the session on SIGHUP. @xref{Detach}.
34 @item autonuke @var{state}
35 Enable a clear screen to discard unwritten output. @xref{Autonuke}.
36 -@item bce @var{[state]}
37 +@item bce [@var{state}]
38 Change background color erase. @xref{Character Processing}.
39 -@item bell_msg @var{[message]}
40 +@item bell_msg [@var{message}]
41 Set the bell notification message. @xref{Bell}.
42 -@item bind @var{key [command [args]]}
43 +@item bind key [@code{command [@var{args}]}]
44 Bind a command to a key. @xref{Bind}.
45 -@item bindkey @var{[opts] [string [cmd args]]}
46 +@item bindkey [@code{opts}] [@code{string [@var{cmd args}]}]
47 Bind a string to a series of keystrokes. @xref{Bindkey}.
48 -@item break @var{[duration]}
49 +@item break [@var{duration}]
50 Send a break signal to the current window. @xref{Break}.
51 -@item breaktype @var{[tcsendbreak | TCSBRK | TIOCSBRK]}
52 +@item breaktype [@var{tcsendbreak | TCSBRK | TIOCSBRK}]
53 Specify how to generate breaks. @xref{Break}.
54 -@item bufferfile @var{[exchange-file]}
55 +@item bufferfile [@var{exchange-file}]
56 Select a file for screen-exchange. @xref{Screen-Exchange}.
57 -@item c1 @var{[state]}
58 +@item c1 [@var{state}]
59 Change c1 code processing. @xref{Character Processing}.
60 -@item caption @var{mode} @var{[string]}
61 +@item caption @var{mode} [@var{string}]
62 Change caption mode and string. @xref{Regions}.
63 @item chacl @var{usernames permbits list}
64 Synonym to @code{aclchg}. @xref{Multiuser Session}.
65 @item charset @var{set}
66 Change character set slot designation. @xref{Character Processing}.
67 -@item chdir @var{[directory]}
68 +@item chdir [@var{directory}]
69 Change the current directory for future windows. @xref{Chdir}.
71 Clear the window screen. @xref{Clear}.
73 Enter a @code{screen} command. @xref{Colon}.
75 Simulate the screen escape key. @xref{Command Character}.
76 -@item compacthist @var{[state]}
77 +@item compacthist [@var{state}]
78 Selects compaction of trailing empty lines. @xref{Scrollback}.
79 -@item console @var{[state]}
80 +@item console [@var{state}]
81 Grab or ungrab console output. @xref{Console}.
83 Enter copy mode. @xref{Copy}.
84 -@item copy_reg @var{[key]}
85 +@item copy_reg [@var{key}]
86 Removed. Use @code{paste} instead. @xref{Registers}.
87 @item crlf @var{state}
88 Select line break behavior for copying. @xref{Line Termination}.
90 Select default autonuke behavior. @xref{Autonuke}.
91 @item defbce @var{state}
92 Select background color erase. @xref{Character Processing}.
93 -@item defbreaktype @var{[tcsendbreak | TCSBRK | TIOCSBRK]}
94 +@item defbreaktype [@var{tcsendbreak | TCSBRK | TIOCSBRK}]
95 Specify the default for generating breaks. @xref{Break}.
96 @item defc1 @var{state}
97 Select default c1 processing behavior. @xref{Character Processing}.
98 -@item defcharset @var{[set]}
99 +@item defcharset [@var{set}]
100 Change defaul character set slot designation. @xref{Character Processing}.
101 @item defescape @var{xy}
102 Set the default command and @code{meta} characters. @xref{Command Character}.
104 Select default flow control behavior. @xref{Flow}.
105 @item defgr @var{state}
106 Select default GR processing behavior. @xref{Character Processing}.
107 -@item defhstatus @var{[status]}
108 +@item defhstatus [@var{status}]
109 Select default window hardstatus line. @xref{Hardstatus}.
110 @item defkanji @var{wtype}
111 Select default GR processing behavior. @xref{Character Processing}.
113 Set default line-wrapping behavior. @xref{Wrap}.
114 @item defwritelock @var{on|off|auto}
115 Set default writelock behavior. @xref{Multiuser Session}.
116 -@item defzombie @var{[keys]}
117 +@item defzombie [@var{keys}]
118 Keep dead windows. @xref{Zombie}.
120 Disconnect @code{screen} from the terminal. @xref{Detach}.
121 @@ -883,15 +883,15 @@
122 Display a message on startup. @xref{Startup}.
123 @item escape @var{xy}
124 Set the command and @code{meta} characters. @xref{Command Character}.
125 -@item exec @var{[[fdpat] command [args ...]]}
126 +@item exec [@code{[@var{fdpat}] command [@var{args ...}]}]
127 Run a subprocess (filter). @xref{Exec}.
129 Change window size to current display size. @xref{Window Size}.
130 -@item flow @var{[fstate]}
131 +@item flow [@var{fstate}]
132 Set flow control behavior. @xref{Flow}.
134 Move focus to next region. @xref{Regions}.
135 -@item gr @var{[state]}
136 +@item gr [@var{state}]
137 Change GR charset processing. @xref{Character Processing}.
139 Write out the contents of the current window. @xref{Hardcopy}.
141 Append to hardcopy files. @xref{Hardcopy}.
142 @item hardcopydir @var{directory}
143 Place, where to dump hardcopy files. @xref{Hardcopy}.
144 -@item hardstatus @var{[state]}
145 +@item hardstatus [@var{state}]
146 Use the hardware status line. @xref{Hardware Status Line}.
147 -@item height @var{[lines]}
148 +@item height [@var{lines}]
149 Set display height. @xref{Window Size}.
151 Display current key bindings. @xref{Help}.
153 Change the window's hardstatus line. @xref{Hardstatus}.
155 Display terminal settings. @xref{Info}.
156 -@item ins_reg @var{[key]}
157 +@item ins_reg [@var{key}]
158 Removed, use @code{paste} instead. @xref{Registers}.
159 -@item kanji @var{wtype [dtype]}
160 +@item kanji @code{wtype [@var{dtype}]}
161 Set the kanji type of a window. @xref{Character Processing}.
163 Destroy the current window. @xref{Kill}.
164 @@ -923,13 +923,13 @@
165 Display licensing information. @xref{Startup}.
167 Lock the controlling terminal. @xref{Lock}.
168 -@item log @var{[state]}
169 +@item log [@var{state}]
170 Log all output in the current window. @xref{Log}.
171 @item logfile @var{filename}
172 Place where to collect logfiles. @xref{Log}.
173 -@item login @var{[state]}
174 +@item login [@var{state}]
175 Log the window in @file{/etc/utmp}. @xref{Login}.
176 -@item logtstamp @var{[state]}
177 +@item logtstamp [@var{state}]
178 Configure logfile time-stamps. @xref{Log}.
180 Use only the default mapping table for the next keystroke. @xref{Bindkey Control}.
182 Rebind keys in copy mode. @xref{Copy Mode Keys}.
184 Insert the command character. @xref{Command Character}.
185 -@item monitor @var{[state]}
186 +@item monitor [@var{state}]
187 Monitor activity in window. @xref{Monitor}.
188 @item msgminwait @var{sec}
189 Set minimum message wait. @xref{Message Wait}.
191 Switch to the next window. @xref{Selecting}.
192 @item nonblock @var{state}
193 Disable flow control to the current display. @xref{Nonblock}.
194 -@item number @var{[n]}
195 +@item number [@var{n}]
196 Change/display the current window's number. @xref{Number}.
197 -@item obuflimit @var{[limit]}
198 +@item obuflimit [@var{limit}]
199 Select output buffer limit. @xref{Obuflimit}.
201 Kill all other regions. @xref{Regions}.
202 @@ -965,29 +965,29 @@
203 Switch to the window you were in last. @xref{Selecting}.
204 @item partial @var{state}
205 Set window to partial refresh. @xref{Redisplay}.
206 -@item password @var{[crypted_pw]}
207 +@item password [@var{crypted_pw}]
208 Set reattach password. @xref{Detach}.
209 -@item paste @var{[src_regs [dest_reg]]}
210 +@item paste [@code{src_regs [@var{dest_reg}]}]
211 Paste contents of paste buffer or registers somewhere. @xref{Paste}.
212 -@item pastefont @var{[state]}
213 +@item pastefont [@var{state}]
214 Include font information in the paste buffer. @xref{Paste}.
216 Close and Reopen the window's terminal. @xref{Break}.
218 Detach and hang up. @xref{Power Detach}.
219 -@item pow_detach_msg @var{[message]}
220 +@item pow_detach_msg [@var{message}]
221 Set message displayed on @code{pow_detach}. @xref{Power Detach}.
223 Switch to the previous window. @xref{Selecting}.
224 -@item printcmd @var{[cmd]}
225 +@item printcmd [@var{cmd}]
226 Set a command for VT100 printer port emulation. @xref{Printcmd}.
227 -@item process @var{[key]}
228 +@item process [@var{key}]
229 Treat a register as input to @code{screen}. @xref{Registers}.
231 Kill all windows and exit. @xref{Quit}.
233 Read the paste buffer from the screen-exchange file. @xref{Screen-Exchange}.
234 -@item readreg @var{[reg [file]]}
235 +@item readreg [@code{reg [@var{file}]}]
236 Load a register from paste buffer or file. @xref{Registers}.
238 Redisplay the current window. @xref{Redisplay}.
239 @@ -999,21 +999,21 @@
240 Delete the screen-exchange file. @xref{Screen-Exchange}.
242 Reset the terminal settings for the window. @xref{Reset}.
243 -@item screen @var{[opts] [n] [cmd [args]]}
244 +@item screen [@var{opts}] [@var{n}] [@code{cmd [@var{args}]}]
245 Create a new window. @xref{Screen Command}.
246 @item scrollback @var{num}
247 Set size of scrollback buffer. @xref{Scrollback}.
248 -@item select @var{[n]}
249 +@item select [@var{n}]
250 Switch to a specified window. @xref{Selecting}.
251 -@item sessionname @var{[name]}
252 +@item sessionname [@var{name}]
253 Name this session. @xref{Session Name}.
254 -@item setenv @var{[var [string]]}
255 +@item setenv [@code{[@var{string}]}]
256 Set an environment variable for new windows. @xref{Setenv}.
257 @item shell @var{command}
258 Set the default program for new windows. @xref{Shell}.
259 @item shelltitle @var{title}
260 Set the default name for new windows. @xref{Shell}.
261 -@item silence @var{[state|seconds]}
262 +@item silence [@var{state|seconds}]
263 Monitor a window for inactivity. @xref{Silence}.
264 @item silencewait @var{seconds}
265 Default timeout to trigger an inactivity notify. @xref{Silence}.
266 @@ -1021,7 +1021,7 @@
267 Pause during startup. @xref{Startup}.
268 @item slowpaste @var{msec}
269 Slow down pasting in windows. @xref{Paste}.
270 -@item sorendition @var{[attr [color]]}
271 +@item sorendition [@code{attr [@var{color}]}]
272 Change text highlighting. @xref{Sorendition}.
274 Split region into two parts. @xref{Regions}.
275 @@ -1029,29 +1029,29 @@
276 Display copyright notice on startup. @xref{Startup}.
277 @item stuff @var{string}
278 Stuff a string in the input buffer of a window. @xref{Paste}.
279 -@item su @var{[username [password [password2]]]}
280 +@item su [@code{[@code{username} [@code{password [@code{password2}]}]}]
281 Identify a user. @xref{Multiuser Session}.
283 Put session in background. @xref{Suspend}.
284 @item term @var{term}
285 Set @code{$TERM} for new windows. @xref{Term}.
286 -@item termcap @var{term terminal-tweaks [window-tweaks]}
287 +@item termcap term terminal-tweaks [@var{window-tweaks}]
288 Tweak termcap entries for best performance. @xref{Termcap Syntax}.
289 -@item terminfo @var{term terminal-tweaks [window-tweaks]}
290 +@item terminfo @code{term terminal-tweaks [@var{window-tweaks}]}
291 Ditto, for terminfo systems. @xref{Termcap Syntax}.
292 -@item termcapinfo @var{term terminal-tweaks [window-tweaks]}
293 +@item termcapinfo @code{term terminal-tweaks [@var{window-tweaks}]}
294 Ditto, for both systems. @xref{Termcap Syntax}.
296 Display time and load average. @xref{Time}.
297 -@item title @var{[windowtitle]}
298 +@item title [@var{windowtitle}]
299 Set the name of the current window. @xref{Title Command}.
300 -@item umask @var{[users]+\-bits ...}
301 +@item umask [@var{users}]+\-bits ...
302 Synonym to @code{aclumask}. @xref{Umask}.
303 @item unsetenv @var{var}
304 Unset environment variable for new windows. @xref{Setenv}.
305 -@item vbell @var{[state]}
306 +@item vbell [@var{state}]
307 Use visual bell. @xref{Bell}.
308 -@item vbell_msg @var{[message]}
309 +@item vbell_msg [@var{message}]
310 Set vbell message. @xref{Bell}.
311 @item vbellwait @var{sec}
312 Set delay for vbell message. @xref{Bell}.
313 @@ -1059,11 +1059,11 @@
314 Display @code{screen} version. @xref{Version}.
315 @item wall @var{message}
316 Write a message to all displays. @xref{Multiuser Session}.
317 -@item width @var{[num]}
318 +@item width [@var{num}]
319 Set the width of the window. @xref{Window Size}.
321 List active windows. @xref{Windows}.
322 -@item wrap @var{[state]}
323 +@item wrap [@var{state}]
324 Control line-wrap behavior. @xref{Wrap}.
326 Write paste buffer to screen-exchange file. @xref{Screen-Exchange}.
327 @@ -1073,7 +1073,7 @@
328 Send an XOFF character. @xref{XON/XOFF}.
330 Send an XON character. @xref{XON/XOFF}.
331 -@item zombie @var{[keys]}
332 +@item zombie [@var{keys}]
333 Keep dead windows. @xref{Zombie}.
336 @@ -1544,7 +1544,7 @@
338 @node Aclgrp, Displays, Acldel, Multiuser Session
340 -@deffn Command aclgrp @var{username [groupname]}
341 +@deffn Command aclgrp username [@var{groupname}]
343 Creates groups of users that share common access rights. The
344 name of the group is the username of the group leader. Each
345 @@ -1568,8 +1568,8 @@
347 @node Umask, Wall, Displays, Multiuser Session
349 -@deffn Command aclumask @var{[[users]+bits |[users]-bits .... ]}
350 -@deffnx Command umask @var{[[users]+bits |[users]-bits .... ]}
351 +@deffn Command aclumask [@code{[users]+bits |[users]-bits .... }]
352 +@deffnx Command umask [@code{[users]+bits |[users]-bits .... }]
354 This specifies the access other users have to windows that
355 will be created by the caller of the command. @var{Users} may be no,
356 @@ -1616,7 +1616,7 @@
358 @node Su, , Writelock, Multiuser Session
360 -@deffn Command su @var{[username [password [password2]]]}
361 +@deffn Command @code{su} [@code{username [@code{password} [@var{password2}]]}]
363 Substitute the user of a display. The command prompts for
364 all parameters that are omitted. If passwords are specified
365 @@ -1634,7 +1634,7 @@
367 @node Session Name, Suspend, Multiuser Session, Session Management
368 @section Session Name
369 -@deffn Command sessionname @var{[name]}
370 +@deffn Command sessionname [@var{name}]
372 Rename the current session. Note that for @code{screen -list} the name
373 shows up with the process-id prepended. If the argument @var{name} is
374 @@ -1730,7 +1730,7 @@
376 @node Resize, Caption, Remove, Regions
378 -@deffn Command resize @var{[(+/-)lines]}
379 +@deffn Command resize [@code{\(+/-\)lines}]
381 Resize the current region. The space will be removed from or added to
382 the region below or if there's not enough space from the region above.
383 @@ -1757,7 +1757,7 @@
386 The second form changes the text used for the caption. You can use
387 -all string escapes (@xref{String Escapes}). @code{Screen} uses
388 +all string escapes (@pxref{String Escapes}). @code{Screen} uses
389 a default of @samp{%3n %t}.
391 You can mix both forms by providing the string as an additional
392 @@ -1949,7 +1949,7 @@
394 @node Console, Kill, Naming Windows, Window Settings
396 -@deffn Command console @var{[state]}
397 +@deffn Command console [@var{state}]
399 Grabs or un-grabs the machines console output to a window. When the argument
400 is omitted the current state is displayed.
401 @@ -2271,7 +2271,7 @@
402 change after a reattach from a different terminal type, it is
403 possible to bind commands to the termcap name of the keys.
404 @code{Screen} will insert the correct binding after each
405 -reattach. @xref{Bindkey} for further details on the syntax and examples.
406 +reattach. (@pxref{Bindkey} for further details on the syntax and examples.)
408 Here is the table of the default key bindings. (A) means that the
409 command is executed if the keyboard is switched into application
410 @@ -2435,7 +2435,7 @@
411 starting with @samp{(1,1)}, the terminal width and height plus the size
412 of the scrollback buffer in lines, like in @samp{(80,24)+50},
413 the current state of window XON/XOFF flow control is shown like this
414 -(see also @xref{Flow Control}):
415 +(@pxref{Flow Control}):
417 +flow automatic flow control, currently on.
418 -flow automatic flow control, currently off.
419 @@ -2537,7 +2537,7 @@
420 the @code{termcap} command (@pxref{Termcap}), for more information.
423 -@deffn Command height @var{[lines]}
424 +@deffn Command height [@var{lines}]
426 Set the display height to a specified number of lines. When no
427 argument is given it toggles between 24 and 42 lines display.
428 @@ -2599,7 +2599,7 @@
429 @samp{.} chars). New windows have @samp{BBBB02} as default
430 charset, unless a @samp{kanji} command is active.
432 -The current setting can be viewed with the @xref{Info} command.
433 +The current setting can be viewed with the @xref{Info}, command.
436 @deffn Command defc1 state
437 @@ -2960,7 +2960,7 @@
438 Stuff the string @var{string} in the input buffer of the current window.
439 This is like the @code{paste} command, but with much less overhead.
440 You cannot paste large buffers with the @code{stuff} command. It is most
441 -useful for key bindings. @xref{Bindkey}
442 +useful for key bindings (@pxref{Bindkey}).
446 @@ -3032,7 +3032,7 @@
448 @node Exec, Using Exec, , Subprocess Execution
450 -@deffn Command exec @var{[[fdpat] newcommand [args ... ]]}
451 +@deffn Command exec [@var{fdpat newcommand args ... }]
453 Run a unix subprocess (specified by an executable path @var{newcommand} and
454 its optional arguments) in the current window. The flow of data between
455 @@ -3241,14 +3241,14 @@
457 @node Bindkey, Bindkey Examples, Help, Key Binding
459 -@deffn Command bindkey @var{[opts] [string [cmd args]]}
460 +@deffn Command bindkey [@var{opts}] [@var{string cmd args}]
462 This command manages screen's input translation tables. Every
463 entry in one of the tables tells screen how to react if a certain
464 sequence of characters is encountered. There are three tables:
465 one that should contain actions programmed by the user, one for
466 the default actions used for terminal emulation and one for
467 -screen's copy mode to do cursor movement. @xref{Input Translation}
468 +screen's copy mode to do cursor movement. @xref{Input Translation},
469 for a list of default key bindings.
472 @@ -3786,7 +3786,7 @@
474 @node Obuflimit, Character Translation, Autonuke, Termcap
476 -@deffn Command obuflimit @var{[limit]}
477 +@deffn Command obuflimit [@var{limit}]
479 If the output buffer contains more bytes than the specified limit, no
480 more data will be read from the windows. The default value is 256. If
481 @@ -3932,7 +3932,7 @@
482 current window (settable via @samp{\E]0;^G} or @samp{\E_\\}) is
484 You can customize this to any string you like including
485 -string escapes (@xref{String Escapes}).
486 +string escapes (@xref{String Escapes}.).
488 out the argument @var{string}, the current string is displayed.
490 @@ -4224,7 +4224,7 @@
491 @node Number, Silence, Nonblock, Miscellaneous
494 -@deffn Command number @var{[n]}
495 +@deffn Command number [@var{n}]
497 Change the current window's number. If the given number @var{n} is already
498 used by another window, both windows exchange their numbers. If no argument is
499 @@ -4233,7 +4233,7 @@
501 @node Silence, Time, Number, Miscellaneous
503 -@deffn Command silence @var{[state|sec]}
504 +@deffn Command silence [@var{state|sec}]
506 Toggles silence monitoring of windows. When silence is turned on and an
507 affected window is switched into the background, you will receive the
508 @@ -4284,8 +4284,8 @@
510 @node Zombie, Printcmd, Version, Miscellaneous
512 -@deffn Command zombie @var{[keys]}
513 -@deffnx Command defzombie @var{[keys]}
514 +@deffn Command zombie [@var{keys}]
515 +@deffnx Command defzombie [@var{keys}]
517 Per default windows are removed from the window list as soon as the
518 windows process (e.g. shell) exits. When a string of two keys is
519 @@ -4304,7 +4304,7 @@
521 @node Printcmd, Sorendition, Zombie, Miscellaneous
523 -@deffn Command printcmd @var{[cmd]}
524 +@deffn Command printcmd [@var{cmd}]
526 If @var{cmd} is not an empty string, screen will not use the terminal
527 capabilities @code{po/pf} for printing if it detects an ansi print
528 @@ -4320,7 +4320,7 @@
530 @node Sorendition, , Printcmd, Miscellaneous
532 -@deffn Command sorendition @var{[attr [color]]}
533 +@deffn Command sorendition [@var{attr color}]
535 Change the way screen does highlighting for text marking and printing
537 @@ -4674,8 +4674,7 @@
538 @cindex socket directory
540 The socket directory defaults either to @file{$HOME/.screen} or simply to
541 -@file{/tmp/screens} or preferably to @file{/usr/local/screens} chosen at
542 -compile-time. If @code{screen} is installed
543 +@file{/tmp/screens} chosen at compile-time. If @code{screen} is installed
544 setuid root, then the administrator should compile screen with an
545 adequate (not NFS mounted) @code{SOCKDIR}. If @code{screen} is not
546 running setuid-root, the user can specify any mode 700 directory in the