diff options
author | Mattias Andrée <maandree@member.fsf.org> | 2015-12-17 13:46:48 +0100 |
---|---|---|
committer | Mattias Andrée <maandree@member.fsf.org> | 2015-12-17 13:46:48 +0100 |
commit | 1d16c042d53a224b5f260019fef7ce171cf51f65 (patch) | |
tree | 7e757af1d29c2e2201f29ae5c9b18b4031bb3de6 /doc | |
parent | extend rationale (diff) | |
download | vtchs-1d16c042d53a224b5f260019fef7ce171cf51f65.tar.gz vtchs-1d16c042d53a224b5f260019fef7ce171cf51f65.tar.bz2 vtchs-1d16c042d53a224b5f260019fef7ce171cf51f65.tar.xz |
add man page
Signed-off-by: Mattias Andrée <maandree@member.fsf.org>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/vtchs.1 | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/man/vtchs.1 b/doc/man/vtchs.1 new file mode 100644 index 0000000..9c6d261 --- /dev/null +++ b/doc/man/vtchs.1 @@ -0,0 +1,42 @@ +.TH VTCHS 1 VTCHS +.SH NAME +vtchs \- Listen for VT switches +.SH ETYMOLOGY +.IR v irtual +.IR t erminal +.IR ch ange s +.SH SYNOPSIS +.B vtchs +.SH DESCRIPTION +.B vtchs +ignores all arguments. You must have set +stdin to be a +.B /dev/tty +device. +.PP +When +.B vtchs +starts, it prints the number of the +currently active console. Then, in an infinite +loop, it waits for the user to change console, +and prints the number of the newly active console +when this happens. +.SH RATIONALE +Sometimes you need to be able to know which +console is in the foreground, and stay up to +date on this. In particular, I want to be able +to record the output on the mintors, and have +it detect VT switches, so it can select the +appropriate method and display; and I want to +be able to have VT dependent colour adjustments. +.SH SEE ALSO +.BR fgconsole (1), +.BR chvt (1) +.SH AUTHORS +Principal author, Mattias Andrée. See the LICENSE file for the full +list of authors. +.SH LICENSE +MIT/X Consortium License. +.SH BUGS +Please report bugs to https://github.com/maandree/vtchs/issues or to +maandree@member.fsf.org |