Asciidoc: Review term-utils man pages

This commit is contained in:
Mario Blättermann 2021-03-25 18:22:30 +01:00
parent d9a67eb510
commit 28f4f1a37d
8 changed files with 215 additions and 213 deletions

View File

@ -35,158 +35,156 @@ This program does not use the _/etc/gettydefs_ (System V) or _/etc/gettytab_ (Su
== ARGUMENTS
_port_::
A path name relative to the `/dev` directory. If a "-" is specified, *agetty* assumes that its standard input is already connected to a tty port and that a connection to a remote user has already been established. +
{nbsp} +
Under System V, a "-" _port_ argument should be preceded by a "--".
A path name relative to the _/dev_ directory. If a "-" is specified, *agetty* assumes that its standard input is already connected to a tty port and that a connection to a remote user has already been established.
+
Under System V, a "-" _port_ argument should be preceded by a "--".
_baud_rate_,...::
A comma-separated list of one or more baud rates. Each time *agetty* receives a BREAK character it advances through the list, which is treated as if it were circular. +
{nbsp} +
Baud rates should be specified in descending order, so that the null character (Ctrl-@) can also be used for baud-rate switching. +
{nbsp} +
This argument is optional and unnecessary for *virtual terminals*. +
{nbsp} +
The default for *serial terminals* is keep the current baud rate (see *--keep-baud*) and if unsuccessful then default to '9600'.
A comma-separated list of one or more baud rates. Each time *agetty* receives a BREAK character it advances through the list, which is treated as if it were circular.
+
Baud rates should be specified in descending order, so that the null character (Ctrl-@) can also be used for baud-rate switching.
+
This argument is optional and unnecessary for *virtual terminals*.
+
The default for *serial terminals* is keep the current baud rate (see *--keep-baud*) and if unsuccessful then default to '9600'.
_term_::
The value to be used for the *TERM* environment variable. This overrides whatever *init*(1) may have set, and is inherited by login and the shell. +
{nbsp} +
The default is 'vt100', or 'linux' for Linux on a virtual terminal, or 'hurd' for GNU Hurd on a virtual terminal.
The value to be used for the *TERM* environment variable. This overrides whatever *init*(1) may have set, and is inherited by login and the shell.
+
The default is 'vt100', or 'linux' for Linux on a virtual terminal, or 'hurd' for GNU Hurd on a virtual terminal.
== OPTIONS
*-8*, *--8bits*::
Assume that the tty is 8-bit clean, hence disable parity detection.
Assume that the tty is 8-bit clean, hence disable parity detection.
*-a*, *--autologin* _username_::
Automatically log in the specified user without asking for a username or password. Using this option causes an *-f* _username_ option and argument to be added to the */bin/login* command line. See *--login-options*, which can be used to modify this option's behavior. +
{nbsp} +
Note that *--autologin* may affect the way in which *getty* initializes the serial line, because on auto-login *agetty* does not read from the line and it has no opportunity optimize the line setting.
Automatically log in the specified user without asking for a username or password. Using this option causes an *-f* _username_ option and argument to be added to the */bin/login* command line. See *--login-options*, which can be used to modify this option's behavior.
+
Note that *--autologin* may affect the way in which *getty* initializes the serial line, because on auto-login *agetty* does not read from the line and it has no opportunity optimize the line setting.
*-c*, *--noreset*::
Do not reset terminal cflags (control modes). See *termios*(3) for more details.
Do not reset terminal cflags (control modes). See *termios*(3) for more details.
*-E*, *--remote*::
Typically the *login*(1) command is given a remote hostname when called by something such as *telnetd*(8). This option allows *agetty* to pass what it is using for a hostname to *login*(1) for use in *utmp*(5). See *--host*, *login*(1), and *utmp*(5). +
{nbsp} +
If the *--host* _fakehost_ option is given, then an *-h* _fakehost_ option and argument are added to the _/bin/login_ command line. +
{nbsp} +
If the *--nohostname* option is given, then an *-H* option is added to the */bin/login* command line. +
{nbsp} +
See *--login-options*.
Typically the *login*(1) command is given a remote hostname when called by something such as *telnetd*(8). This option allows *agetty* to pass what it is using for a hostname to *login*(1) for use in *utmp*(5). See *--host*, *login*(1), and *utmp*(5).
+
If the *--host* _fakehost_ option is given, then an *-h* _fakehost_ option and argument are added to the _/bin/login_ command line.
+
If the *--nohostname* option is given, then an *-H* option is added to the */bin/login* command line.
+
See *--login-options*.
*-f*, *--issue-file* _path_::
Specifies a ":" delimited list of files and directories to be displayed instead of _/etc/issue_ (or other). All specified files and directories are displayed, missing or empty files are silently ignored. If the specified path is a directory then display all files with .issue file extension in version-sort order from the directory. This allows custom messages to be displayed on different terminals. The *--noissue* option will override this option.
Specifies a ":" delimited list of files and directories to be displayed instead of _/etc/issue_ (or other). All specified files and directories are displayed, missing or empty files are silently ignored. If the specified path is a directory then display all files with .issue file extension in version-sort order from the directory. This allows custom messages to be displayed on different terminals. The *--noissue* option will override this option.
*--show-issue*::
Display the current issue file (or other) on the current terminal and exit. Use this option to review the current setting, it is not designed for any other purpose. Note that output may use some default or incomplete information as proper output depends on terminal and agetty command line.
Display the current issue file (or other) on the current terminal and exit. Use this option to review the current setting, it is not designed for any other purpose. Note that output may use some default or incomplete information as proper output depends on terminal and agetty command line.
*-h, --flow-control*::
Enable hardware (RTS/CTS) flow control. It is left up to the application to disable software (XON/XOFF) flow protocol where appropriate.
Enable hardware (RTS/CTS) flow control. It is left up to the application to disable software (XON/XOFF) flow protocol where appropriate.
*-H*, *--host* _fakehost_::
Write the specified _fakehost_ into the utmp file. Normally, no login host is given, since *agetty* is used for local hardwired connections and consoles. However, this option can be useful for identifying terminal concentrators and the like.
Write the specified _fakehost_ into the utmp file. Normally, no login host is given, since *agetty* is used for local hardwired connections and consoles. However, this option can be useful for identifying terminal concentrators and the like.
*-i*, *--noissue*::
Do not display the contents of _/etc/issue_ (or other) before writing the login prompt. Terminals or communications hardware may become confused when receiving lots of text at the wrong baud rate; dial-up scripts may fail if the login prompt is preceded by too much text.
Do not display the contents of _/etc/issue_ (or other) before writing the login prompt. Terminals or communications hardware may become confused when receiving lots of text at the wrong baud rate; dial-up scripts may fail if the login prompt is preceded by too much text.
*-I*, *--init-string* _initstring_::
Set an initial string to be sent to the tty or modem before sending anything else. This may be used to initialize a modem. Non-printable characters may be sent by writing their octal code preceded by a backslash (\). For example, to send a linefeed character (ASCII 10, octal 012), write \12.
Set an initial string to be sent to the tty or modem before sending anything else. This may be used to initialize a modem. Non-printable characters may be sent by writing their octal code preceded by a backslash (\). For example, to send a linefeed character (ASCII 10, octal 012), write \12.
*-J*, *--noclear*::
Do not clear the screen before prompting for the login name. By default the screen is cleared.
Do not clear the screen before prompting for the login name. By default the screen is cleared.
*-l*, *--login-program* _login_program_::
Invoke the specified _login_program_ instead of /bin/login. This allows the use of a non-standard login program. Such a program could, for example, ask for a dial-up password or use a different password file. See *--login-options*.
Invoke the specified _login_program_ instead of /bin/login. This allows the use of a non-standard login program. Such a program could, for example, ask for a dial-up password or use a different password file. See *--login-options*.
*-L*, *--local-line*[=__mode__]::
Control the CLOCAL line flag. The optional _mode_ argument is 'auto', 'always' or 'never'. If the _mode_ argument is omitted, then the default is 'always'. If the *--local-line* option is not given at all, then the default is 'auto'.
Control the CLOCAL line flag. The optional _mode_ argument is 'auto', 'always' or 'never'. If the _mode_ argument is omitted, then the default is 'always'. If the *--local-line* option is not given at all, then the default is 'auto'.
____
_always_::
Forces the line to be a local line with no need for carrier detect. This can be useful when you have a locally attached terminal where the serial line does not set the carrier-detect signal.
_never_::
Explicitly clears the CLOCAL flag from the line setting and the carrier-detect signal is expected on the line.
_auto_::
The *agetty* default. Does not modify the CLOCAL setting and follows the setting enabled by the kernel.
____
_always_;;
Forces the line to be a local line with no need for carrier detect. This can be useful when you have a locally attached terminal where the serial line does not set the carrier-detect signal.
_never_;;
Explicitly clears the CLOCAL flag from the line setting and the carrier-detect signal is expected on the line.
_auto_;;
The *agetty* default. Does not modify the CLOCAL setting and follows the setting enabled by the kernel.
*-m*, *--extract-baud*::
Try to extract the baud rate from the CONNECT status message produced by Hayes(tm)-compatible modems. These status messages are of the form: "<junk><speed><junk>". *agetty* assumes that the modem emits its status message at the same speed as specified with (the first) _baud_rate_ value on the command line. +
{nbsp} +
Since the *--extract-baud* feature may fail on heavily-loaded systems, you still should enable BREAK processing by enumerating all expected baud rates on the command line.
Try to extract the baud rate from the CONNECT status message produced by Hayes(tm)-compatible modems. These status messages are of the form: "<junk><speed><junk>". *agetty* assumes that the modem emits its status message at the same speed as specified with (the first) _baud_rate_ value on the command line.
+
Since the *--extract-baud* feature may fail on heavily-loaded systems, you still should enable BREAK processing by enumerating all expected baud rates on the command line.
*--list-speeds*::
Display supported baud rates. These are determined at compilation time.
Display supported baud rates. These are determined at compilation time.
*-n*, *--skip-login*::
Do not prompt the user for a login name. This can be used in connection with the *--login-program* option to invoke a non-standard login process such as a BBS system. Note that with the *--skip-login* option, *agetty* gets no input from the user who logs in and therefore will not be able to figure out parity, character size, and newline processing of the connection. It defaults to space parity, 7 bit characters, and ASCII CR (13) end-of-line character. Beware that the program that *agetty* starts (usually /bin/login) is run as root.
Do not prompt the user for a login name. This can be used in connection with the *--login-program* option to invoke a non-standard login process such as a BBS system. Note that with the *--skip-login* option, *agetty* gets no input from the user who logs in and therefore will not be able to figure out parity, character size, and newline processing of the connection. It defaults to space parity, 7 bit characters, and ASCII CR (13) end-of-line character. Beware that the program that *agetty* starts (usually /bin/login) is run as root.
*-N*, *--nonewline*::
Do not print a newline before writing out _/etc/issue_.
Do not print a newline before writing out _/etc/issue_.
*-o*, *--login-options* _login_options_::
Options and arguments that are passed to *login*(1). Where \u is replaced by the login name. For example: +
{nbsp} +
*--login-options '-h darkstar -- \u'* +
{nbsp} +
See *--autologin*, *--login-program* and *--remote*. +
{nbsp} +
Please read the SECURITY NOTICE below before using this option.
Options and arguments that are passed to *login*(1). Where \u is replaced by the login name. For example:
+
*--login-options '-h darkstar -- \u'*
+
See *--autologin*, *--login-program* and *--remote*.
+
Please read the SECURITY NOTICE below before using this option.
*-p*, *--login-pause*::
Wait for any key before dropping to the login prompt. Can be combined with *--autologin* to save memory by lazily spawning shells.
Wait for any key before dropping to the login prompt. Can be combined with *--autologin* to save memory by lazily spawning shells.
*-r*, *--chroot* _directory_::
Change root to the specified directory.
Change root to the specified directory.
*-R*, *--hangup*::
Call *vhangup*(2) to do a virtual hangup of the specified terminal.
Call *vhangup*(2) to do a virtual hangup of the specified terminal.
*-s*, *--keep-baud*::
Try to keep the existing baud rate. The baud rates from the command line are used when *agetty* receives a BREAK character. If another baud rates specified then the original baud rate is also saved to the end of the wanted baud rates list. This can be used to return to the original baud rate after unexpected BREAKs.
Try to keep the existing baud rate. The baud rates from the command line are used when *agetty* receives a BREAK character. If another baud rates specified then the original baud rate is also saved to the end of the wanted baud rates list. This can be used to return to the original baud rate after unexpected BREAKs.
*-t*, *--timeout* _timeout_::
Terminate if no user name could be read within _timeout_ seconds. Use of this option with hardwired terminal lines is not recommended.
Terminate if no user name could be read within _timeout_ seconds. Use of this option with hardwired terminal lines is not recommended.
*-U*, *--detect-case*::
Turn on support for detecting an uppercase-only terminal. This setting will detect a login name containing only capitals as indicating an uppercase-only terminal and turn on some upper-to-lower case conversions. Note that this has no support for any Unicode characters.
Turn on support for detecting an uppercase-only terminal. This setting will detect a login name containing only capitals as indicating an uppercase-only terminal and turn on some upper-to-lower case conversions. Note that this has no support for any Unicode characters.
*-w*, *--wait-cr*::
Wait for the user or the modem to send a carriage-return or a linefeed character before sending the _/etc/issue_ file (or others) and the login prompt. This is useful with the *--init-string* option.
Wait for the user or the modem to send a carriage-return or a linefeed character before sending the _/etc/issue_ file (or others) and the login prompt. This is useful with the *--init-string* option.
*--nohints*::
Do not print hints about Num, Caps and Scroll Locks.
Do not print hints about Num, Caps and Scroll Locks.
*--nohostname*::
By default the hostname will be printed. With this option enabled, no hostname at all will be shown.
By default the hostname will be printed. With this option enabled, no hostname at all will be shown.
*--long-hostname*::
By default the hostname is only printed until the first dot. With this option enabled, the fully qualified hostname by *gethostname*(3P) or (if not found) by *getaddrinfo*(3) is shown.
By default the hostname is only printed until the first dot. With this option enabled, the fully qualified hostname by *gethostname*(3P) or (if not found) by *getaddrinfo*(3) is shown.
*--erase-chars* _string_::
This option specifies additional characters that should be interpreted as a backspace ("ignore the previous character") when the user types the login name. The default additional ´erase´ has been ´#´, but since util-linux 2.23 no additional erase characters are enabled by default.
This option specifies additional characters that should be interpreted as a backspace ("ignore the previous character") when the user types the login name. The default additional ´erase´ has been ´#´, but since util-linux 2.23 no additional erase characters are enabled by default.
*--kill-chars* _string_::
This option specifies additional characters that should be interpreted as a kill ("ignore all previous characters") when the user types the login name. The default additional ´kill´ has been ´@´, but since util-linux 2.23 no additional kill characters are enabled by default.
This option specifies additional characters that should be interpreted as a kill ("ignore all previous characters") when the user types the login name. The default additional ´kill´ has been ´@´, but since util-linux 2.23 no additional kill characters are enabled by default.
*--chdir* _directory_::
Change directory before the login.
Change directory before the login.
*--delay* _number_::
Sleep seconds before open tty.
Sleep seconds before open tty.
*--nice* _number_::
Run login with this priority.
Run login with this priority.
*--reload*::
Ask all running agetty instances to reload and update their displayed prompts, if the user has not yet commenced logging in. After doing so the command will exit. This feature might be unsupported on systems without Linux *inotify*(7).
Ask all running agetty instances to reload and update their displayed prompts, if the user has not yet commenced logging in. After doing so the command will exit. This feature might be unsupported on systems without Linux *inotify*(7).
*--version*::
Display version information and exit.
Display version information and exit.
*--help*::
Display help text and exit.
Display help text and exit.
== EXAMPLE
@ -237,55 +235,55 @@ It is possible to review the current issue file by *agetty --show-issue* on the
The issue files may contain certain escape codes to display the system name, date, time et cetera. All escape codes consist of a backslash (\) immediately followed by one of the characters listed below.
4 or 4{_interface_}::
Insert the IPv4 address of the specified network interface (for example: \4\{eth0}). If the _interface_ argument is not specified, then select the first fully configured (UP, non-LOCALBACK, RUNNING) interface. If not any configured interface is found, fall back to the IP address of the machine's hostname.
Insert the IPv4 address of the specified network interface (for example: \4\{eth0}). If the _interface_ argument is not specified, then select the first fully configured (UP, non-LOCALBACK, RUNNING) interface. If not any configured interface is found, fall back to the IP address of the machine's hostname.
6 or 6{_interface_}::
The same as \4 but for IPv6.
The same as \4 but for IPv6.
b::
Insert the baudrate of the current line.
Insert the baudrate of the current line.
d::
Insert the current date.
Insert the current date.
e or e{_name_}::
Translate the human-readable _name_ to an escape sequence and insert it (for example: \e{red}Alert text.\e{reset}). If the _name_ argument is not specified, then insert \033. The currently supported names are: black, blink, blue, bold, brown, cyan, darkgray, gray, green, halfbright, lightblue, lightcyan, lightgray, lightgreen, lightmagenta, lightred, magenta, red, reset, reverse, yellow and white. All unknown names are silently ignored.
Translate the human-readable _name_ to an escape sequence and insert it (for example: \e{red}Alert text.\e{reset}). If the _name_ argument is not specified, then insert \033. The currently supported names are: black, blink, blue, bold, brown, cyan, darkgray, gray, green, halfbright, lightblue, lightcyan, lightgray, lightgreen, lightmagenta, lightred, magenta, red, reset, reverse, yellow and white. All unknown names are silently ignored.
s::
Insert the system name (the name of the operating system). Same as 'uname -s'. See also the \S escape code.
Insert the system name (the name of the operating system). Same as 'uname -s'. See also the \S escape code.
S or S{VARIABLE}::
Insert the VARIABLE data from _/etc/os-release_. If this file does not exist then fall back to _/usr/lib/os-release_. If the VARIABLE argument is not specified, then use PRETTY_NAME from the file or the system name (see \s). This escape code can be used to keep _/etc/issue_ distribution and release independent. Note that \S{ANSI_COLOR} is converted to the real terminal escape sequence.
Insert the VARIABLE data from _/etc/os-release_. If this file does not exist then fall back to _/usr/lib/os-release_. If the VARIABLE argument is not specified, then use PRETTY_NAME from the file or the system name (see \s). This escape code can be used to keep _/etc/issue_ distribution and release independent. Note that \S{ANSI_COLOR} is converted to the real terminal escape sequence.
l::
Insert the name of the current tty line.
Insert the name of the current tty line.
m::
Insert the architecture identifier of the machine. Same as *uname -m*.
Insert the architecture identifier of the machine. Same as *uname -m*.
n::
Insert the nodename of the machine, also known as the hostname. Same as *uname -n*.
Insert the nodename of the machine, also known as the hostname. Same as *uname -n*.
o::
Insert the NIS domainname of the machine. Same as *hostname -d*.
Insert the NIS domainname of the machine. Same as *hostname -d*.
O::
Insert the DNS domainname of the machine.
Insert the DNS domainname of the machine.
r::
Insert the release number of the OS. Same as *uname -r*.
Insert the release number of the OS. Same as *uname -r*.
t::
Insert the current time.
Insert the current time.
u::
Insert the number of current users logged in.
Insert the number of current users logged in.
U::
Insert the string "1 user" or "<n> users" where <n> is the number of current users logged in.
Insert the string "1 user" or "<n> users" where <n> is the number of current users logged in.
v::
Insert the version of the OS, that is, the build-date and such.
Insert the version of the OS, that is, the build-date and such.
An example. On my system, the following _/etc/issue_ file:
@ -302,19 +300,19 @@ This is thingol.orcan.dk (Linux i386 1.1.9) 18:29:30
== FILES
_/var/run/utmp_::
the system status file.
the system status file.
_/etc/issue_::
printed before the login prompt.
printed before the login prompt.
_/etc/os-release /usr/lib/os-release_::
operating system identification data.
operating system identification data.
_/dev/console_::
problem reports (if *syslog*(3) is not used).
problem reports (if *syslog*(3) is not used).
_/etc/inittab_::
*init*(8) configuration file for SysV-style init daemon.
*init*(8) configuration file for SysV-style init daemon.
== BUGS
@ -330,7 +328,7 @@ Depending on how the program was configured, all diagnostics are written to the
== AUTHORS
mailto:werner@suse.de[Werner Fink] +
mailto:werner@suse.de[Werner Fink],
mailto:kzak@redhat.com[Karel Zak]
The original *agetty* for serial terminals was written by mailto:wietse@wzv.win.tue.nl[W.Z. Venema] and ported to Linux by mailto:poe@daimi.aau.dk[Peter Orbaek].

View File

@ -59,36 +59,34 @@ The *mesg* utility silently exits with error status 2 if not executed on termina
== ARGUMENTS
*n*::
Disallow messages.
Disallow messages.
*y*::
Allow messages to be displayed.
Allow messages to be displayed.
If no arguments are given, *mesg* shows the current message status on standard error output.
== OPTIONS
*-v*, *--verbose*::
Explain what is being done.
Explain what is being done.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== EXIT STATUS
The *mesg* utility exits with one of the following values:
____
*0*::
Messages are allowed.
Messages are allowed.
*1*::
Messages are not allowed.
Messages are not allowed.
*>1*::
An error has occurred.
____
An error has occurred.
== FILES

View File

@ -39,6 +39,7 @@ SUCH DAMAGE.
:man source: util-linux {release-version}
:page-layout: base
:command: script
:plus: +
== NAME
@ -63,65 +64,66 @@ Note that logging input using *--log-in* or *--log-io* may record security-sensi
Below, the _size_ argument may be followed by the multiplicative suffixes KiB (=1024), MiB (=1024*1024), and so on for GiB, TiB, PiB, EiB, ZiB and YiB (the "iB" is optional, e.g., "K" has the same meaning as "KiB"), or the suffixes KB (=1000), MB (=1000*1000), and so on for GB, TB, PB, EB, ZB and YB.
*-a*, *--append*::
Append the output to _file_ or to _typescript_, retaining the prior contents.
Append the output to _file_ or to _typescript_, retaining the prior contents.
*-c*, *--command* _command_::
Run the _command_ rather than an interactive shell. This makes it easy for a script to capture the output of a program that behaves differently when its stdout is not a tty.
Run the _command_ rather than an interactive shell. This makes it easy for a script to capture the output of a program that behaves differently when its stdout is not a tty.
*-E*, *--echo* _when_::
This option controls the *ECHO* flag for the slave end of the session's pseudoterminal. The supported modes are _always_, _never_, or _auto_. +
{nbsp} +
The default is _auto_ -- in this case, *ECHO* enabled for the pseudoterminal slave; if the current standard input is a terminal, *ECHO* is disabled for it to prevent double echo; if the current standard input is not a terminal (for example pipe: *echo date | script*) then keeping *ECHO* enabled for the pseudoterminal slave enables the standard input data to be viewed on screen while being recorded to session log simultaneously. +
{nbsp} +
Note that 'never' mode affects content of the session output log, because users input is not repeated on output.
This option controls the *ECHO* flag for the slave end of the session's pseudoterminal. The supported modes are _always_, _never_, or _auto_.
+
The default is _auto_ -- in this case, *ECHO* enabled for the pseudoterminal slave; if the current standard input is a terminal, *ECHO* is disabled for it to prevent double echo; if the current standard input is not a terminal (for example pipe: *echo date | script*) then keeping *ECHO* enabled for the pseudoterminal slave enables the standard input data to be viewed on screen while being recorded to session log simultaneously.
+
Note that 'never' mode affects content of the session output log, because users input is not repeated on output.
*-e*, *--return*::
Return the exit status of the child process. Uses the same format as bash termination on signal termination (i.e., exit status is 128 + the signal number). The exit status of the child process is always stored in the type script file too.
Return the exit status of the child process. Uses the same format as bash termination on signal termination (i.e., exit status is 128 {plus} the signal number). The exit status of the child process is always stored in the type script file too.
//TRANSLATORS: Keep {plus} untranslated.
*-f*, *--flush*::
Flush output after each write. This is nice for telecooperation: one person does *mkfifo foo; script -f foo*, and another can supervise in real-time what is being done using *cat foo*. Note that flush has an impact on performance; it's possible to use *SIGUSR1* to flush logs on demand.
Flush output after each write. This is nice for telecooperation: one person does *mkfifo foo; script -f foo*, and another can supervise in real-time what is being done using *cat foo*. Note that flush has an impact on performance; it's possible to use *SIGUSR1* to flush logs on demand.
*--force*::
Allow the default output file _typescript_ to be a hard or symbolic link. The command will follow a symbolic link.
Allow the default output file _typescript_ to be a hard or symbolic link. The command will follow a symbolic link.
*-B*, *--log-io* _file_::
Log input and output to the same _file_. Note, this option makes sense only if *--log-timing* is also specified, otherwise it's impossible to separate output and input streams from the log _file_.
Log input and output to the same _file_. Note, this option makes sense only if *--log-timing* is also specified, otherwise it's impossible to separate output and input streams from the log _file_.
*-I*, *--log-in* _file_::
Log input to the _file_. The log output is disabled if only *--log-in* specified. +
{nbsp} +
Use this logging functionality carefully as it logs all input, including input when terminal has disabled echo flag (for example, password inputs).
Log input to the _file_. The log output is disabled if only *--log-in* specified.
+
Use this logging functionality carefully as it logs all input, including input when terminal has disabled echo flag (for example, password inputs).
*-O*, *--log-out* _file_::
Log output to the _file_. The default is to log output to the file with name _typescript_ if the option *--log-out* or *--log-in* is not given. The log output is disabled if only *--log-in* specified.
Log output to the _file_. The default is to log output to the file with name _typescript_ if the option *--log-out* or *--log-in* is not given. The log output is disabled if only *--log-in* specified.
*-T*, *--log-timing* _file_::
Log timing information to the _file_. Two timing file formats are supported now. The classic format is used when only one stream (input or output) logging is enabled. The multi-stream format is used on *--log-io* or when *--log-in* and *--log-out* are used together. See also *--logging-format*.
Log timing information to the _file_. Two timing file formats are supported now. The classic format is used when only one stream (input or output) logging is enabled. The multi-stream format is used on *--log-io* or when *--log-in* and *--log-out* are used together. See also *--logging-format*.
*-m*, *--logging-format* _format_::
Force use of _advanced_ or _classic_ format. The default is the classic format to log only output and the advanced format when input as well as output logging is requested.
Force use of _advanced_ or _classic_ format. The default is the classic format to log only output and the advanced format when input as well as output logging is requested.
*Classic format*:::
The log contains two fields, separated by a space. The first field indicates how much time elapsed since the previous output. The second field indicates how many characters were output this time.
The log contains two fields, separated by a space. The first field indicates how much time elapsed since the previous output. The second field indicates how many characters were output this time.
*Advanced (multi-stream) format*:::
The first field is an entry type identifier ('I'nput, 'O'utput, 'H'eader, 'S'ignal). The socond field is how much time elapsed since the previous entry, and the rest of the entry is type-specific data.
The first field is an entry type identifier ('I'nput, 'O'utput, 'H'eader, 'S'ignal). The socond field is how much time elapsed since the previous entry, and the rest of the entry is type-specific data.
*-o*, *--output-limit* _size_::
Limit the size of the typescript and timing files to _size_ and stop the child process after this size is exceeded. The calculated file size does not include the start and done messages that the *script* command prepends and appends to the child process output. Due to buffering, the resulting output file might be larger than the specified value.
Limit the size of the typescript and timing files to _size_ and stop the child process after this size is exceeded. The calculated file size does not include the start and done messages that the *script* command prepends and appends to the child process output. Due to buffering, the resulting output file might be larger than the specified value.
*-q*, *--quiet*::
Be quiet (do not write start and done messages to standard output).
Be quiet (do not write start and done messages to standard output).
*-t*[_file_], *--timing*[=_file_]::
Output timing data to standard error, or to _file_ when given. This option is deprecated in favour of *--log-timing* where the _file_ argument is not optional.
Output timing data to standard error, or to _file_ when given. This option is deprecated in favour of *--log-timing* where the _file_ argument is not optional.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== SIGNALS
@ -132,7 +134,7 @@ Upon receiving *SIGUSR1*, *script* immediately flushes the output files.
The following environment variable is utilized by *script*:
*SHELL*::
If the variable *SHELL* exists, the shell forked by *script* will be that shell. If *SHELL* is not set, the Bourne shell is assumed. (Most shells set this variable automatically).
If the variable *SHELL* exists, the shell forked by *script* will be that shell. If *SHELL* is not set, the Bourne shell is assumed. (Most shells set this variable automatically).
== NOTES

View File

@ -27,28 +27,28 @@ The timing information is what script1 outputs to file specified by *--log-timin
== OPTIONS
*-I*, *--log-in* _file_::
File containing *script*'s terminal input.
File containing *script*'s terminal input.
*-B*, *--log-io* _file_::
File containing *script*'s terminal output and input.
File containing *script*'s terminal output and input.
*-t*, *--timing* _file_::
File containing *script*'s timing output. This option overrides old-style arguments.
File containing *script*'s timing output. This option overrides old-style arguments.
*-T*, *--log-timing* _file_::
Aliased to *-t*, maintained for compatibility with *script*(1) command-line options.
Aliased to *-t*, maintained for compatibility with *script*(1) command-line options.
*-d*, *--divisor* _number_::
Speed up the replay displaying this _number_ of times. The argument is a floating-point number. It's called divisor because it divides the timings by this factor. This option overrides old-style arguments.
Speed up the replay displaying this _number_ of times. The argument is a floating-point number. It's called divisor because it divides the timings by this factor. This option overrides old-style arguments.
*-m*, *--maxdelay* _number_::
Set the maximum delay between updates to _number_ of seconds. The argument is a floating-point number. This can be used to avoid long pauses in the typescript replay.
Set the maximum delay between updates to _number_ of seconds. The argument is a floating-point number. This can be used to avoid long pauses in the typescript replay.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== EXAMPLES

View File

@ -5,6 +5,7 @@
:man source: util-linux {release-version}
:page-layout: base
:command: scriptreplay
:copyright: ©
== NAME
@ -29,43 +30,43 @@ If the third parameter or *--divisor* is specified, it is used as a speed-up mul
== OPTIONS
*-I*, *--log-in* _file_::
File containing *script*'s terminal input.
File containing *script*'s terminal input.
*-O*, *--log-out* _file_::
File containing *script*'s terminal output.
File containing *script*'s terminal output.
*-B*, *--log-io* _file_::
File containing *script*'s terminal output and input.
File containing *script*'s terminal output and input.
*-t*, *--timing* _file_::
File containing *script*'s timing output. This option overrides old-style arguments.
File containing *script*'s timing output. This option overrides old-style arguments.
*-T*, *--log-timing* _file_::
This is an alias for *-t*, maintained for compatibility with *script*(1) command-line options.
This is an alias for *-t*, maintained for compatibility with *script*(1) command-line options.
*-s*, *--typescript* _file_::
File containing *script*'s terminal output. Deprecated alias to *--log-out*. This option overrides old-style arguments.
File containing *script*'s terminal output. Deprecated alias to *--log-out*. This option overrides old-style arguments.
*-c*, *--cr-mode* _mode_::
Specifies how to use the CR (0x0D, carriage return) character from log files. The default mode is _auto_, in this case CR is replaced with line break for stdin log, because otherwise *scriptreplay* would overwrite the same line. The other modes are _never_ and _always_.
Specifies how to use the CR (0x0D, carriage return) character from log files. The default mode is _auto_, in this case CR is replaced with line break for stdin log, because otherwise *scriptreplay* would overwrite the same line. The other modes are _never_ and _always_.
*-d*, *--divisor* _number_::
Speed up the replay displaying this _number_ of times. The argument is a floating-point number. It's called divisor because it divides the timings by this factor. This option overrides old-style arguments.
Speed up the replay displaying this _number_ of times. The argument is a floating-point number. It's called divisor because it divides the timings by this factor. This option overrides old-style arguments.
*-m*, *--maxdelay* _number_::
Set the maximum delay between updates to _number_ of seconds. The argument is a floating-point number. This can be used to avoid long pauses in the typescript replay.
Set the maximum delay between updates to _number_ of seconds. The argument is a floating-point number. This can be used to avoid long pauses in the typescript replay.
*--summary*::
Display details about the session recorded in the specified timing file and exit. The session has to be recorded using _advanced_ format (see *script*(1)) option *--logging-format* for more details).
Display details about the session recorded in the specified timing file and exit. The session has to be recorded using _advanced_ format (see *script*(1)) option *--logging-format* for more details).
*-x*, *--stream* _type_::
Forces *scriptreplay* to print only the specified stream. The supported stream types are _in_, _out_, _signal_, or _info_. This option is recommended for multi-stream logs (e.g., *--log-io*) in order to print only specified data.
Forces *scriptreplay* to print only the specified stream. The supported stream types are _in_, _out_, _signal_, or _info_. This option is recommended for multi-stream logs (e.g., *--log-io*) in order to print only specified data.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== EXAMPLES
@ -85,8 +86,11 @@ The original *scriptreplay* program was written by mailto:joey@kitenet.net[Joey
== COPYRIGHT
Copyright © 2008 James Youngman +
Copyright © 2008-2019 Karel Zak
//TRANSLATORS: Keep {copyright} untranslated.
Copyright {copyright} 2008 James Youngman
//TRANSLATORS: Keep {copyright} untranslated.
Copyright {copyright} 2008-2019 Karel Zak
This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

View File

@ -38,127 +38,127 @@ The various color options may be set independently, at least on virtual consoles
The optional arguments require '=' (equals sign) and not space between the option and the argument. For example --option=argument.
*--appcursorkeys* on|off::
Sets Cursor Key Application Mode on or off. When on, ESC O A, ESC O B, etc. will be sent for the cursor keys instead of ESC [ A, ESC [ B, etc. See the _vi and Cursor-Keys_ section of the _Text-Terminal-HOWTO_ for how this can cause problems for *vi* users. Virtual consoles only.
Sets Cursor Key Application Mode on or off. When on, ESC O A, ESC O B, etc. will be sent for the cursor keys instead of ESC [ A, ESC [ B, etc. See the _vi and Cursor-Keys_ section of the _Text-Terminal-HOWTO_ for how this can cause problems for *vi* users. Virtual consoles only.
*--append* _console_number_::
Like *--dump*, but appends to the snapshot file instead of overwriting it. Only works if no *--dump* options are given.
Like *--dump*, but appends to the snapshot file instead of overwriting it. Only works if no *--dump* options are given.
*--background* __8-color__|default::
Sets the background text color.
Sets the background text color.
*--blank*[=0-60|force|poke]::
Sets the interval of inactivity, in minutes, after which the screen will be automatically blanked (using APM if available). Without an argument, it gets the blank status (returns which vt was blanked, or zero for an unblanked vt). Virtual consoles only. +
{nbsp} +
The *force* argument keeps the screen blank even if a key is pressed. +
{nbsp} +
The *poke* argument unblanks the screen.
Sets the interval of inactivity, in minutes, after which the screen will be automatically blanked (using APM if available). Without an argument, it gets the blank status (returns which vt was blanked, or zero for an unblanked vt). Virtual consoles only.
+
The *force* argument keeps the screen blank even if a key is pressed.
+
The *poke* argument unblanks the screen.
*--bfreq*[=_number_]::
Sets the bell frequency in Hertz. Without an argument, it defaults to *0*. Virtual consoles only.
Sets the bell frequency in Hertz. Without an argument, it defaults to *0*. Virtual consoles only.
*--blength*[=0-2000]::
Sets the bell duration in milliseconds. Without an argument, it defaults to *0*. Virtual consoles only.
Sets the bell duration in milliseconds. Without an argument, it defaults to *0*. Virtual consoles only.
*--blink* on|off::
Turns blink mode on or off. Except on a virtual console, *--blink off* turns off all attributes (bold, half-brightness, blink, reverse).
Turns blink mode on or off. Except on a virtual console, *--blink off* turns off all attributes (bold, half-brightness, blink, reverse).
*--bold* on|off::
urns bold (extra bright) mode on or off. Except on a virtual console, *--bold off* turns off all attributes (bold, half-brightness, blink, reverse).
urns bold (extra bright) mode on or off. Except on a virtual console, *--bold off* turns off all attributes (bold, half-brightness, blink, reverse).
*--clear*[=all|rest]::
Without an argument or with the argument *all*, the entire screen is cleared and the cursor is set to the home position, just like *clear*(1) does. With the argument *rest*, the screen is cleared from the current cursor position to the end.
Without an argument or with the argument *all*, the entire screen is cleared and the cursor is set to the home position, just like *clear*(1) does. With the argument *rest*, the screen is cleared from the current cursor position to the end.
*--clrtabs*[=_tab1 tab2 tab3_ ...]::
Clears tab stops from the given horizontal cursor positions, in the range *1-160*. Without arguments, it clears all tab stops. Virtual consoles only.
Clears tab stops from the given horizontal cursor positions, in the range *1-160*. Without arguments, it clears all tab stops. Virtual consoles only.
*--cursor* on|off::
Turns the terminal's cursor on or off.
Turns the terminal's cursor on or off.
*--default*::
Sets the terminal's rendering options to the default values.
Sets the terminal's rendering options to the default values.
*--dump*[=_console_number_]::
Writes a snapshot of the virtual console with the given number to the file specified with the *--file* option, overwriting its contents; the default is _screen.dump_. Without an argument, it dumps the current virtual console. This overrides *--append*.
Writes a snapshot of the virtual console with the given number to the file specified with the *--file* option, overwriting its contents; the default is _screen.dump_. Without an argument, it dumps the current virtual console. This overrides *--append*.
*--file* _filename_::
Sets the snapshot file name for any *--dump* or *--append* options on the same command line. If this option is not present, the default is _screen.dump_ in the current directory. A path name that exceeds the system maximum will be truncated, see *PATH_MAX* from _linux/limits.h_ for the value.
Sets the snapshot file name for any *--dump* or *--append* options on the same command line. If this option is not present, the default is _screen.dump_ in the current directory. A path name that exceeds the system maximum will be truncated, see *PATH_MAX* from _linux/limits.h_ for the value.
*--foreground* __8-color__|default::
Sets the foreground text color.
Sets the foreground text color.
*--half-bright* on|off::
Turns dim (half-brightness) mode on or off. Except on a virtual console, *--half-bright off* turns off all attributes (bold, half-brightness, blink, reverse).
Turns dim (half-brightness) mode on or off. Except on a virtual console, *--half-bright off* turns off all attributes (bold, half-brightness, blink, reverse).
*--hbcolor* [bright] _16-color_::
Sets the color for half-bright characters.
Sets the color for half-bright characters.
*--initialize*::
Displays the terminal initialization string, which typically sets the terminal's rendering options, and other attributes to the default values.
Displays the terminal initialization string, which typically sets the terminal's rendering options, and other attributes to the default values.
*--inversescreen* on|off::
Swaps foreground and background colors for the whole screen.
Swaps foreground and background colors for the whole screen.
*--linewrap* on|off::
Makes the terminal continue on a new line when a line is full.
Makes the terminal continue on a new line when a line is full.
*--msg* on|off::
Enables or disables the sending of kernel *printk*() messages to the console. Virtual consoles only.
Enables or disables the sending of kernel *printk*() messages to the console. Virtual consoles only.
*--msglevel* 0-8::
Sets the console logging level for kernel *printk()* messages. All messages strictly more important than this will be printed, so a logging level of *0* has the same effect as *--msg on* and a logging level of *8* will print all kernel messages. *klogd*(8) may be a more convenient interface to the logging of kernel messages. +
{nbsp} +
Virtual consoles only.
Sets the console logging level for kernel *printk()* messages. All messages strictly more important than this will be printed, so a logging level of *0* has the same effect as *--msg on* and a logging level of *8* will print all kernel messages. *klogd*(8) may be a more convenient interface to the logging of kernel messages.
+
Virtual consoles only.
*--powerdown*[=0-60]::
Sets the VESA powerdown interval in minutes. Without an argument, it defaults to *0* (disable powerdown). If the console is blanked or the monitor is in suspend mode, then the monitor will go into vsync suspend mode or powerdown mode respectively after this period of time has elapsed.
Sets the VESA powerdown interval in minutes. Without an argument, it defaults to *0* (disable powerdown). If the console is blanked or the monitor is in suspend mode, then the monitor will go into vsync suspend mode or powerdown mode respectively after this period of time has elapsed.
*--powersave* _mode_::
Valid values for _mode_ are: +
{nbsp} +
*vsync|on*;;
Puts the monitor into VESA vsync suspend mode.
*hsync*;;
Puts the monitor into VESA hsync suspend mode.
*powerdown*;;
Puts the monitor into VESA powerdown mode.
*off*;;
Turns monitor VESA powersaving features.
Valid values for _mode_ are:
*vsync|on*;;
Puts the monitor into VESA vsync suspend mode.
*hsync*;;
Puts the monitor into VESA hsync suspend mode.
*powerdown*;;
Puts the monitor into VESA powerdown mode.
*off*;;
Turns monitor VESA powersaving features.
*--regtabs*[=1-160]::
Clears all tab stops, then sets a regular tab stop pattern, with one tab every specified number of positions. Without an argument, it defaults to *8*. Virtual consoles only.
Clears all tab stops, then sets a regular tab stop pattern, with one tab every specified number of positions. Without an argument, it defaults to *8*. Virtual consoles only.
*--repeat* on|off::
Turns keyboard repeat on or off. Virtual consoles only.
Turns keyboard repeat on or off. Virtual consoles only.
*--reset*::
Displays the terminal reset string, which typically resets the terminal to its power-on state.
Displays the terminal reset string, which typically resets the terminal to its power-on state.
*--resize*::
Reset terminal size by assessing maximum row and column. This is useful when actual geometry and kernel terminal driver are not in sync. Most notable use case is with serial consoles, that do not use *ioctl*(3p) but just byte streams and breaks.
Reset terminal size by assessing maximum row and column. This is useful when actual geometry and kernel terminal driver are not in sync. Most notable use case is with serial consoles, that do not use *ioctl*(3p) but just byte streams and breaks.
*--reverse* on|off::
Turns reverse video mode on or off. Except on a virtual console, *--reverse off* turns off all attributes (bold, half-brightness, blink, reverse).
Turns reverse video mode on or off. Except on a virtual console, *--reverse off* turns off all attributes (bold, half-brightness, blink, reverse).
*--store*::
Stores the terminal's current rendering options (foreground and background colors) as the values to be used at reset-to-default. Virtual consoles only.
Stores the terminal's current rendering options (foreground and background colors) as the values to be used at reset-to-default. Virtual consoles only.
*--tabs*[=_tab1 tab2 tab3_ ...]::
Sets tab stops at the given horizontal cursor positions, in the range *1-160*. Without arguments, it shows the current tab stop settings.
Sets tab stops at the given horizontal cursor positions, in the range *1-160*. Without arguments, it shows the current tab stop settings.
*--term* _terminal_name_::
Overrides the *TERM* environment variable.
Overrides the *TERM* environment variable.
*--ulcolor* [bright] _16-color_::
Sets the color for underlined characters. Virtual consoles only.
Sets the color for underlined characters. Virtual consoles only.
*--underline* on|off::
Turns underline mode on or off.
Turns underline mode on or off.
*--version*::
Displays version information and exits.
Displays version information and exits.
*--help*::
Displays a help text and exits.
Displays a help text and exits.
== COMPATIBILITY

View File

@ -60,23 +60,23 @@ Reading from a _file_ is refused when the invoker is not superuser and the progr
== OPTIONS
*-n*, *--nobanner*::
Suppress the banner.
Suppress the banner.
*-t*, *--timeout* _timeout_::
Abandon the write attempt to the terminals after _timeout_ seconds. This _timeout_ must be a positive integer. The default value is 300 seconds, which is a legacy from the time when people ran terminals over modem lines.
Abandon the write attempt to the terminals after _timeout_ seconds. This _timeout_ must be a positive integer. The default value is 300 seconds, which is a legacy from the time when people ran terminals over modem lines.
*-g*, *--group* _group_::
Limit printing message to members of group defined as a _group_ argument. The argument can be group name or GID.
Limit printing message to members of group defined as a _group_ argument. The argument can be group name or GID.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== NOTES
Some sessions, such as wdm, that have in the beginning of *utmp*(5) ut_type data a ':' character will not get the message from *wall*. This is done to avoid write errors.
Some sessions, such as *wdm*(1x), that have in the beginning of *utmp*(5) ut_type data a ':' character will not get the message from *wall*. This is done to avoid write errors.
== HISTORY

View File

@ -72,10 +72,10 @@ The traditional protocol for writing to someone is that the string _-o_, either
== OPTIONS
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== HISTORY