aboutsummaryrefslogtreecommitdiffstats
path: root/src/consoletype.1
diff options
context:
space:
mode:
Diffstat (limited to 'src/consoletype.1')
-rw-r--r--src/consoletype.135
1 files changed, 23 insertions, 12 deletions
diff --git a/src/consoletype.1 b/src/consoletype.1
index 2720f871..3f4ec14b 100644
--- a/src/consoletype.1
+++ b/src/consoletype.1
@@ -1,28 +1,39 @@
.TH CONSOLETYPE 1 "Red Hat, Inc" "RH" \" -*- nroff -*-
.SH NAME
-.B consoletype
+\fBconsoletype
\- print type of the console connected to standard input
.SH SYNOPSIS
-.B consoletype
+\fBconsoletype [\fIfg\fR]
.SH DESCRIPTION
-.B consoletype
-prints the type of console connected to standard input. It prints
-.I vt
+\fBconsoletype
+prints the type of console connected to standard input, and checks
+whether the console connected to standard input is the current
+foreground virtual console. With no arguments, it prints
+\fIvt\fR
if console is a virtual terminal (/dev/tty* or /dev/console device if not on
a serial console),
-.I serial
+\fIserial\fR
if standard input is a serial console (/dev/console or /dev/ttyS*) and
-.I pty
+\fIpty\fR
if standard input is a pseudo terminal.
.SH RETURN VALUE
-.B consoletype
-returns
+\fBconsoletype
+when passed no arguments returns
.TP
-.I 0
+\fI0
if on virtual terminal
.TP
-.I 1
+\fI1
if on serial console
.TP
-.I 2
+\fI2
if on a pseudo terminal.
+.TP
+When passed the \fIfg\fR argument, \fBconsoletype\fR returns
+.TP
+\fI0
+if the console connected to standard input is the current virtual
+terminal
+.TP
+\fI1
+otherwise. \ No newline at end of file