]> git.ipfire.org Git - thirdparty/man-pages.git/commitdiff
ioctl_console.2, ioctl_vt.2, VT_*.2const: Split VT_* from ioctl_console(2)
authorAlejandro Colomar <alx@kernel.org>
Sun, 9 Jun 2024 21:42:15 +0000 (23:42 +0200)
committerAlejandro Colomar <alx@kernel.org>
Thu, 13 Jun 2024 21:54:44 +0000 (23:54 +0200)
Signed-off-by: Alejandro Colomar <alx@kernel.org>
12 files changed:
man/man2/ioctl_console.2
man/man2/ioctl_vt.2 [new file with mode: 0644]
man/man2const/VT_ACTIVATE.2const [new file with mode: 0644]
man/man2const/VT_DISALLOCATE.2const [new file with mode: 0644]
man/man2const/VT_GETMODE.2const [new file with mode: 0644]
man/man2const/VT_GETSTATE.2const [new file with mode: 0644]
man/man2const/VT_OPENQRY.2const [new file with mode: 0644]
man/man2const/VT_RELDISP.2const [new file with mode: 0644]
man/man2const/VT_RESIZE.2const [new file with mode: 0644]
man/man2const/VT_RESIZEX.2const [new file with mode: 0644]
man/man2const/VT_SETMODE.2const [new file with mode: 0644]
man/man2const/VT_WAITACTIVE.2const [new file with mode: 0644]

index 5ad576c128e2b189a1d82e7a21abf4570b008cc6..d4f00893e47006d22f405dd771b0651e726d5ec1 100644 (file)
@@ -15,9 +15,6 @@
 .\"     KDKBDREP (since Linux 2.1.113)
 .\"     KDMAPDISP (not implemented as at Linux 2.6.27)
 .\"     KDUNMAPDISP (not implemented as at Linux 2.6.27)
-.\"     VT_LOCKSWITCH (since Linux 1.3.47, needs CAP_SYS_TTY_CONFIG)
-.\"     VT_UNLOCKSWITCH (since Linux 1.3.47, needs CAP_SYS_TTY_CONFIG)
-.\"     VT_GETHIFONTMASK (since Linux 2.6.18)
 .\"
 .TH ioctl_console 2 (date) "Linux man-pages (unreleased)"
 .SH NAME
@@ -530,139 +527,29 @@ when it is generated by pressing an appropriate key combination.
 in
 .IR linux/drivers/char/keyboard.c .)
 .TP
-.B VT_OPENQRY
-Returns the first available (non-opened) console.
-.I argp
-points to an
-.I int
-which is set to the
-number of the vt (1 <=
-.I *argp
-<= MAX_NR_CONSOLES).
+.B TIOCLINUX
 .TP
+.B VT_OPENQRY
+.TQ
 .B VT_GETMODE
-Get mode of active vt.
-.I argp
-points to a
-.IP
-.in +4n
-.EX
-struct vt_mode {
-    char  mode;    /* vt mode */
-    char  waitv;   /* if set, hang on writes if not active */
-    short relsig;  /* signal to raise on release op */
-    short acqsig;  /* signal to raise on acquisition */
-    short frsig;   /* unused (set to 0) */
-};
-.EE
-.in
-.IP
-which is set to the mode of the active vt.
-.I mode
-is set to one of these values:
-.TS
-l l.
-VT_AUTO        auto vt switching
-VT_PROCESS     process controls switching
-VT_ACKACQ      acknowledge switch
-.TE
-.TP
+.TQ
 .B VT_SETMODE
-Set mode of active vt.
-.I argp
-points to a
-.IR "struct vt_mode" .
-.TP
+.TQ
 .B VT_GETSTATE
-Get global vt state info.
-.I argp
-points to a
-.IP
-.in +4n
-.EX
-struct vt_stat {
-    unsigned short v_active;  /* active vt */
-    unsigned short v_signal;  /* signal to send */
-    unsigned short v_state;   /* vt bit mask */
-};
-.EE
-.in
-.IP
-For each vt in use, the corresponding bit in the
-.I v_state
-member is set.
-(Linux 1.0 through Linux 1.1.92.)
-.TP
+.TQ
 .B VT_RELDISP
-Release a display.
-.TP
+.TQ
 .B VT_ACTIVATE
-Switch to vt
-.I argp
-(1 <=
-.I argp
-<= MAX_NR_CONSOLES).
-.TP
+.TQ
 .B VT_WAITACTIVE
-Wait until vt
-.I argp
-has been activated.
-.TP
+.TQ
 .B VT_DISALLOCATE
-Deallocate the memory associated with vt
-.IR argp .
-(Since Linux 1.1.54.)
-.TP
+.TQ
 .B VT_RESIZE
-Set the kernel's idea of screensize.
-.I argp
-points to a
-.IP
-.in +4n
-.EX
-struct vt_sizes {
-    unsigned short v_rows;       /* # rows */
-    unsigned short v_cols;       /* # columns */
-    unsigned short v_scrollsize; /* no longer used */
-};
-.EE
-.in
-.IP
-Note that this does not change the videomode.
-See
-.BR resizecons (8).
-(Since Linux 1.1.54.)
-.TP
+.TQ
 .B VT_RESIZEX
-Set the kernel's idea of various screen parameters.
-.I argp
-points to a
-.IP
-.in +4n
-.EX
-struct vt_consize {
-    unsigned short v_rows;  /* number of rows */
-    unsigned short v_cols;  /* number of columns */
-    unsigned short v_vlin;  /* number of pixel rows
-                               on screen */
-    unsigned short v_clin;  /* number of pixel rows
-                               per character */
-    unsigned short v_vcol;  /* number of pixel columns
-                               on screen */
-    unsigned short v_ccol;  /* number of pixel columns
-                               per character */
-};
-.EE
-.in
-.IP
-Any parameter may be set to zero, indicating "no change", but if
-multiple parameters are set, they must be self-consistent.
-Note that this does not change the videomode.
 See
-.BR resizecons (8).
-(Since Linux 1.3.3.)
-.TP
-.B TIOCLINUX
+.BR ioctl_vt (2).
 .SH RETURN VALUE
 On success, 0 is returned (except where indicated).
 On failure, \-1 is returned, and
@@ -714,6 +601,7 @@ Use POSIX functions.
 .BR execve (2),
 .BR fcntl (2),
 .BR ioctl_tty (2),
+.BR ioctl_vt (2),
 .BR ioperm (2),
 .BR termios (3),
 .BR console_codes (4),
@@ -728,5 +616,4 @@ Use POSIX functions.
 .BR resizecons (8),
 .BR setfont (8)
 .P
-.IR /usr/include/linux/kd.h ,
-.I /usr/include/linux/vt.h
+.I /usr/include/linux/kd.h
diff --git a/man/man2/ioctl_vt.2 b/man/man2/ioctl_vt.2
new file mode 100644 (file)
index 0000000..51cd7c2
--- /dev/null
@@ -0,0 +1,176 @@
+'\" t
+.\" Copyright (c) 1995 Jim Van Zandt <jrv@vanzandt.mv.com> and aeb
+.\" Sun Feb 26 11:46:23 MET 1995
+.\"
+.\" SPDX-License-Identifier: GPL-2.0-or-later
+.\"
+.\" Modified, Sun Feb 26 15:04:20 1995, faith@cs.unc.edu
+.\" Modified, Thu Apr 20 22:08:17 1995, jrv@vanzandt.mv.com
+.\" Modified, Mon Sep 18 22:32:47 1995, hpa@storm.net (H. Peter Anvin)
+.\" FIXME The following are not documented:
+.\"     VT_LOCKSWITCH (since Linux 1.3.47, needs CAP_SYS_TTY_CONFIG)
+.\"     VT_UNLOCKSWITCH (since Linux 1.3.47, needs CAP_SYS_TTY_CONFIG)
+.\"     VT_GETHIFONTMASK (since Linux 2.6.18)
+.\"
+.TH ioctl_vt 2 (date) "Linux man-pages (unreleased)"
+.SH NAME
+ioctl_vt
+\-
+ioctls for console terminal and virtual consoles
+.SH SYNOPSIS
+.nf
+.B #include <sys/ioctl.h>
+.P
+.BI "int ioctl(int " fd ", unsigned long " op ", void *" argp );
+.fi
+.SH DESCRIPTION
+The following Linux-specific
+.BR ioctl (2)
+operations are supported for console terminals and virtual consoles.
+.TP
+.B VT_OPENQRY
+Returns the first available (non-opened) console.
+.I argp
+points to an
+.I int
+which is set to the
+number of the vt (1 <=
+.I *argp
+<= MAX_NR_CONSOLES).
+.TP
+.B VT_GETMODE
+Get mode of active vt.
+.I argp
+points to a
+.IP
+.in +4n
+.EX
+struct vt_mode {
+    char  mode;    /* vt mode */
+    char  waitv;   /* if set, hang on writes if not active */
+    short relsig;  /* signal to raise on release op */
+    short acqsig;  /* signal to raise on acquisition */
+    short frsig;   /* unused (set to 0) */
+};
+.EE
+.in
+.IP
+which is set to the mode of the active vt.
+.I mode
+is set to one of these values:
+.TS
+l l.
+VT_AUTO        auto vt switching
+VT_PROCESS     process controls switching
+VT_ACKACQ      acknowledge switch
+.TE
+.TP
+.B VT_SETMODE
+Set mode of active vt.
+.I argp
+points to a
+.IR "struct vt_mode" .
+.TP
+.B VT_GETSTATE
+Get global vt state info.
+.I argp
+points to a
+.IP
+.in +4n
+.EX
+struct vt_stat {
+    unsigned short v_active;  /* active vt */
+    unsigned short v_signal;  /* signal to send */
+    unsigned short v_state;   /* vt bit mask */
+};
+.EE
+.in
+.IP
+For each vt in use, the corresponding bit in the
+.I v_state
+member is set.
+(Linux 1.0 through Linux 1.1.92.)
+.TP
+.B VT_RELDISP
+Release a display.
+.TP
+.B VT_ACTIVATE
+Switch to vt
+.I argp
+(1 <=
+.I argp
+<= MAX_NR_CONSOLES).
+.TP
+.B VT_WAITACTIVE
+Wait until vt
+.I argp
+has been activated.
+.TP
+.B VT_DISALLOCATE
+Deallocate the memory associated with vt
+.IR argp .
+(Since Linux 1.1.54.)
+.TP
+.B VT_RESIZE
+Set the kernel's idea of screensize.
+.I argp
+points to a
+.IP
+.in +4n
+.EX
+struct vt_sizes {
+    unsigned short v_rows;       /* # rows */
+    unsigned short v_cols;       /* # columns */
+    unsigned short v_scrollsize; /* no longer used */
+};
+.EE
+.in
+.IP
+Note that this does not change the videomode.
+See
+.BR resizecons (8).
+(Since Linux 1.1.54.)
+.TP
+.B VT_RESIZEX
+Set the kernel's idea of various screen parameters.
+.I argp
+points to a
+.IP
+.in +4n
+.EX
+struct vt_consize {
+    unsigned short v_rows;  /* number of rows */
+    unsigned short v_cols;  /* number of columns */
+    unsigned short v_vlin;  /* number of pixel rows
+                               on screen */
+    unsigned short v_clin;  /* number of pixel rows
+                               per character */
+    unsigned short v_vcol;  /* number of pixel columns
+                               on screen */
+    unsigned short v_ccol;  /* number of pixel columns
+                               per character */
+};
+.EE
+.in
+.IP
+Any parameter may be set to zero, indicating "no change", but if
+multiple parameters are set, they must be self-consistent.
+Note that this does not change the videomode.
+See
+.BR resizecons (8).
+(Since Linux 1.3.3.)
+.SH RETURN VALUE
+On success, 0 is returned (except where indicated).
+On failure, \-1 is returned, and
+.I errno
+is set to indicate the error.
+.SH ERRORS
+.TP
+.B EINVAL
+.I argp
+is invalid.
+.SH SEE ALSO
+.BR ioctl (2),
+.BR ioctl_console (2)
+.P
+.I /usr/include/linux/vt.h
diff --git a/man/man2const/VT_ACTIVATE.2const b/man/man2const/VT_ACTIVATE.2const
new file mode 100644 (file)
index 0000000..5c21195
--- /dev/null
@@ -0,0 +1 @@
+.so man2/ioctl_vt.2
diff --git a/man/man2const/VT_DISALLOCATE.2const b/man/man2const/VT_DISALLOCATE.2const
new file mode 100644 (file)
index 0000000..5c21195
--- /dev/null
@@ -0,0 +1 @@
+.so man2/ioctl_vt.2
diff --git a/man/man2const/VT_GETMODE.2const b/man/man2const/VT_GETMODE.2const
new file mode 100644 (file)
index 0000000..5c21195
--- /dev/null
@@ -0,0 +1 @@
+.so man2/ioctl_vt.2
diff --git a/man/man2const/VT_GETSTATE.2const b/man/man2const/VT_GETSTATE.2const
new file mode 100644 (file)
index 0000000..5c21195
--- /dev/null
@@ -0,0 +1 @@
+.so man2/ioctl_vt.2
diff --git a/man/man2const/VT_OPENQRY.2const b/man/man2const/VT_OPENQRY.2const
new file mode 100644 (file)
index 0000000..5c21195
--- /dev/null
@@ -0,0 +1 @@
+.so man2/ioctl_vt.2
diff --git a/man/man2const/VT_RELDISP.2const b/man/man2const/VT_RELDISP.2const
new file mode 100644 (file)
index 0000000..5c21195
--- /dev/null
@@ -0,0 +1 @@
+.so man2/ioctl_vt.2
diff --git a/man/man2const/VT_RESIZE.2const b/man/man2const/VT_RESIZE.2const
new file mode 100644 (file)
index 0000000..5c21195
--- /dev/null
@@ -0,0 +1 @@
+.so man2/ioctl_vt.2
diff --git a/man/man2const/VT_RESIZEX.2const b/man/man2const/VT_RESIZEX.2const
new file mode 100644 (file)
index 0000000..5c21195
--- /dev/null
@@ -0,0 +1 @@
+.so man2/ioctl_vt.2
diff --git a/man/man2const/VT_SETMODE.2const b/man/man2const/VT_SETMODE.2const
new file mode 100644 (file)
index 0000000..5c21195
--- /dev/null
@@ -0,0 +1 @@
+.so man2/ioctl_vt.2
diff --git a/man/man2const/VT_WAITACTIVE.2const b/man/man2const/VT_WAITACTIVE.2const
new file mode 100644 (file)
index 0000000..5c21195
--- /dev/null
@@ -0,0 +1 @@
+.so man2/ioctl_vt.2