From 9750a039c1ece0497a3fec7b2d70f9426637e6f2 Mon Sep 17 00:00:00 2001 From: ru Date: Wed, 17 Jan 2001 09:15:13 +0000 Subject: man(7) -> mdoc(7). --- usr.sbin/pcvt/userkeys/vt220keys.1 | 239 +++++++++++++++++++++---------------- 1 file changed, 138 insertions(+), 101 deletions(-) (limited to 'usr.sbin/pcvt/userkeys') diff --git a/usr.sbin/pcvt/userkeys/vt220keys.1 b/usr.sbin/pcvt/userkeys/vt220keys.1 index d4df9aa..78bd549 100644 --- a/usr.sbin/pcvt/userkeys/vt220keys.1 +++ b/usr.sbin/pcvt/userkeys/vt220keys.1 @@ -1,135 +1,172 @@ .\" $FreeBSD$ .\" -.TH VT220KEYS 1 -.UC 4 -.SH NAME -vt220keys \- define SHIFTED function keys on VT220 terminal -.SH SYNTAX -.B vt220keys -[ -.B \-cil -] -[ keyname keystring ] ... -.SH DESCRIPTION -.I Vt220keys -sets up a "vt220 terminal" in vt200 mode to allow user +.Dd January 16, 2001 +.Dt VT220KEYS 1 +.Os +.Sh NAME +.Nm vt220keys +.Nd "define SHIFTED function keys on VT220 terminal" +.Sh SYNOPSIS +.Nm +.Op Fl cil +.Op Ar keyname keystring ... +.Sh DESCRIPTION +.Nm Vt220keys +sets up a +.Dq "vt220 terminal" +in vt200 mode to allow user definition of the SHIFTED function keys. Each -\f2keyname\f1 specified on the command line will be loaded with -the corresponding \f2keystring\f1. -A \f2keyname\f1 is one of the following "words": -F6 F7 F8 F9 F10 F11 ESC F12 BS F13 LF F14 HELP DO F17 F18 F19 F20. -\f2Keystrings\f1 -must be quoted if spaces, tabs, or shell metacharacters are included. -.PP -.B Vt220keys -expects to receive some combination of option flags and/or +.Ar keyname +specified on the command line will be loaded with +the corresponding +.Ar keystring . +A +.Ar keyname +is one of the following words: +.Cm F6 F7 F8 F9 F10 F11 ESC +.Cm F12 BS F13 LF F14 HELP +.Cm DO F17 F18 F19 F20 . +.Ar Keystrings +must be quoted if spaces, tabs, or shell metacharacters are included. +.Pp +.Nm Vt220keys +expects to receive some combination of option flags and/or argument pair(s), otherwise a usage message is printed. -.PP +.Pp The options are: -.TP -.B \-c +.Bl -tag -width indent +.It Fl c Clears all SHIFTED function key definitions before setting them to user defined strings. -.TP -.B \-i -Read the initialization file -.I $HOME/.vt220rc -for SHIFTED function key definitions. This is done before any +.It Fl i +Read the initialization file +.Pa $HOME/.vt220rc +for SHIFTED function key definitions. +This is done before any argument pair specified on the command line is processed. Each line in the file must consist of two fields (separated by spaces -or tabs) where the first field is the -\f2keyname\f1 and the second field is the \f2keystring\f1. +or tabs) where the first field is the +.Ar keyname +and the second field is the +.Ar keystring . The second field extends to the end of the line, thus a -\f2keystring\f1 -may include spaces or tabs. A newline (return) may be specified +.Ar keystring +may include spaces or tabs. +A newline (return) may be specified within the string by using the C Language notation for newline (\\n). -.TP -.B \-l -Locks the function keys from further definition. -Locking occurs after processing the initialization file (if the "i" +.It Fl l +Locks the function keys from further definition. +Locking occurs after processing the initialization file (if the +.Fl i option is specified) and any argument pairs. The only way to unlock is by turning the power off. -.SH EXAMPLES +.El +.Sh EXAMPLES +.Bd -literal vt220keys -ci -.br vt220keys F6 'nroff -ms ' -.br vt220keys -i F20 'cc -O -c ' -.br vt220keys -l HELP man -.SH "OTHER FEATURES" +.Ed +.Sh "OTHER FEATURES" Pressing the function keys without using the shift key, generates -a string of characters. With -\f2csh\f1(1) this string can be aliased to some command. For example: -.br - alias ^[[17~ "ls -CR | more" -.br -where ^[[17~ is what is generated by pressing the F6 key. Therefore +a string of characters. +With +.Xr csh 1 +this string can be aliased to some command. +For example: +.Pp +.Dl alias\ ^[[17~\ "ls\ -CR\ |\ more" +.Pp +where +.Ql "^[[17~" +is what is generated by pressing the F6 key. +Therefore F6 can perform two commands, depending if pressed with/without the SHIFT key. -.PP -.B Vt220keys -can be called from your .login or .profile file. Typically an user +.Pp +.Nm Vt220keys +can be called from your +.Pa .login +or +.Pa .profile +file. +Typically an user will create a initialization file and include a line like -.br - vt220keys -ci -.br +.Pp +.Dl "vt220keys -ci" OR -.br - vt220keys -cil -.br -in the above mentioned files. This way the SHIFTED function keys +.Dl "vt220keys -cil" +.Pp +in the above mentioned files. +This way the SHIFTED function keys will be set to your favorite commands when logging in. -.SH CAVEATS -If the SHIFTED function keys are unlocked, redefinition of a SHIFTED +.Sh CAVEATS +If the SHIFTED function keys are unlocked, redefinition of a SHIFTED function key will rewrite the old string. -.PP -There are 256 bytes available for the SHIFTED function keys. Space is -supplied on a first-come/first-serve basis. After the 256 bytes are -used, you can't define any more keys unless space is cleared. This -can be done by redefining a key to contain a string of fewer bytes. -.PP +.Pp +There are 256 bytes available for the SHIFTED function keys. +Space is +supplied on a first\-come/first\-serve basis. +After the 256 bytes are +used, you can't define any more keys unless space is cleared. +This +can be done by redefining a key to contain a string of fewer bytes. +.Pp All key definitions are stored in volatile RAM, and are lost when terminal power is lost. -.PP -The ESC key (unshifted) no longer generates the proper escape character. This -is of particular importance since many editors require use of the -ESC key. Here are some available alternatives: -.sp -.in +.5i -The escape character can be generated by typing ^[ (control-[). -.sp -Use -.B vt220keys -as follows (note ^[ is control-[) -.br -.in +.5i -vt220keys ESC '^[' -.in -.br +.Pp +The ESC key (unshifted) no longer generates the proper escape character. +This +is of particular importance since many editors require use of the +ESC key. +Here are some available alternatives: +.Bl -bullet +.It +The escape character can be generated by typing +.Ql ^[ +(control\-[). +.It +Use +.Nm +as follows (note +.Ql ^[ +is control\-[) +.Pp +.Dl "vt220keys ESC '^['" +.Pp This will require you to press the SHIFT key and ESC to generate the escape sequence. -.sp -Some editors, allow other character(s) to be substituted for the +.It +Some editors, allow other character(s) to be substituted for the escape character. -For example with -.B emacs -include this line in your .emacs_pro: -.br - (bind-to-key "ESC-prefix" "\\033[23~") -.br -Thus when the ESC key is pressed, emacs will allow the characters -generated (^[[23~) to perform the same function as the escape +For example with +.Xr emacs 1 +include this line in your +.Pa .emacs_pro : +.Pp +.Dl (bind-to-key\ "ESC-prefix"\ "\\033[23~") +.Pp +Thus when the ESC key is pressed, +.Nm emacs +will allow the characters generated +.Pq Li ^[[23~ +to perform the same function as the escape character. -.in -.SH FILES -$HOME/.vt220rc \- initialization file -.SH "SEE ALSO" -VT220 Programmer Reference Manual -.br -VT220 Programmer Pocket Guide - +.El +.Sh FILES +.Bl -tag -width $HOME/.vt220rc +.It Pa $HOME/.vt220rc +initialization file +.El +.Sh SEE ALSO +.Rs +.%B "VT220 Programmer Reference Manual" +.Re +.Rs +.%B "VT220 Programmer Pocket Guide" +.Re -- cgit v1.1