-- Leo's gemini proxy
-- Connecting to git.thebackupbox.net:1965...
-- Connected
-- Sending request
-- Meta line: 20 text/gemini
repo: rxvt-unicode-sixel action: commit revision: path_from: revision_from: dddf2b69f28580ec07b900df3a15c9d1ca2c8737: path_to: revision_to:
commit dddf2b69f28580ec07b900df3a15c9d1ca2c8737 Author: Marc Lehmann <schmorp@schmorp.de> Date: Thu Aug 12 20:42:13 2004 +0000 *** empty log message *** diff --git a/doc/rxvt.1.pod b/doc/rxvt.1.pod new file mode 100644 index 0000000000000000000000000000000000000000..d75bbb0d45dd89bd55e776aed4e149dc501f8e1d --- /dev/null +++ b/doc/rxvt.1.pod @@ -0,0 +1,915 @@ +=head1 NAME + +rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window system) + +=head1 SYNOPSIS + +B<@@RXVTNAME@@> [options] [-e command [ args ]] + +=head1 DESCRIPTION + +B<rxvt-unicode>, version B<@@RXVTVERSION@@>, is a colour vt102 terminal +emulator intended as an I<xterm>(1) replacement for users who do not +require features such as Tektronix 4014 emulation and toolkit-style +configurability. As a result, B<rxvt-unicode> uses much less swap space -- +a significant advantage on a machine serving many X sessions. + +=head1 OPTIONS + +The B<@@RXVTNAME@@> options (mostly a subset of I<xterm>'s) are listed +below. In keeping with the smaller-is-better philosophy, options may be +eliminated or default values chosen at compile-time, so options and +defaults listed may not accurately reflect the version installed on +your system. `rxvt -h' gives a list of major compile-time options on +the I<Options> line. Option descriptions may be prefixed with which +compile option each is dependent upon. e.g. `Compile I<XIM>:' requires +I<XIM> on the I<Options> line. Note: `rxvt -help' gives a list of all +command-line options compiled into your version. + +Note that B<@@RXVTNAME@@> permits the resource name to be used as a +long-option (--/++ option) so the potential command-line options are +far greater than those listed. For example: `rxvt --loginShell --color1 +Orange'. + +The following options are available: + +=over 4 + +=item B<-help>, B<--help> + +Print out a message describing available options. + +=item B<-display> I<displayname> + +Attempt to open a window on the named X display (B<-d> still +respected). In the absence of this option, the display specified by the +B<DISPLAY> environment variable is used. + +=item B<-geometry> I<geom> + +Window geometry (B<-g> still respected); resource B<geometry>. + +=item B<-rv>|B<+rv> + +Turn on/off simulated reverse video; resource B<reverseVideo>. + +=item B<-j>|B<+j> + +Turn on/off jump scrolling; resource B<jumpScroll>. + +=item B<-ip>|B<+ip> + +Turn on/off inheriting parent window's pixmap. Alternative form is +B<-tr>; resource B<inheritPixmap>. + +=item B<-fade> I<number> + +Fade the text by the given percentage when focus is lost. + +=item B<-tint> I<colour> + +Tint the transparent background pixmap with the given colour when +transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> +option that can be used to brighten or darken the image in addition to +tinting it. + +=item B<-sh> + +I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent +background image in addition to tinting it (i.e. B<-tint> must be +specified, too). + +=item B<-bg> I<colour> + +Window background colour; resource B<background>. + +=item B<-fg> I<colour> + +Window foreground colour; resource B<foreground>. + +=item B<-pixmap> I<file[;geom]> + +Compile I<XPM>: Specify XPM file for the background and also optionally +specify its scaling with a geometry string. Note you may need to add +quotes to avoid special shell interpretation of the `;' in the +command-line; resource B<backgroundPixmap>. + +=item B<-cr> I<colour> + +The cursor colour; resource B<cursorColor>. + +=item B<-pr> I<colour> + +The mouse pointer foreground colour; resource B<pointerColor>. + +=item B<-pr2> I<colour> + +The mouse pointer background colour; resource B<pointerColor2>. + +=item B<-bd> I<colour> + +The colour of the border between the xterm scrollbar and the text; +resource B<borderColor>. + +=item B<-fn> I<fontname> + +Select the fonts to be used. This is a comma seperated list of font +names that are used in turn when trying to display Unicode characters. +The first font defines the cell size for characters; other fonts might +be smaller, but not larger. A reasonable default font list is always +appended to it. resource B<font>. + +=item B<-rb>|B<+rb> + +Enable "real bold" support. When this option is on, bold text will be +displayed using the first available bold font in the font list. Bold +fonts should thus be specified in the font list after their +corresponding regular fonts. If no bold font can be found, a regular +font will be used. resource B<realBold>. + +=item B<-name> I<name> + +Specify the application name under which resources are to be obtained, +rather than the default executable file name. Name should not contain +`.' or `*' characters. Also sets the icon and title name. + +=item B<-ls>|B<+ls> + +Start as a login-shell/sub-shell; resource B<loginShell>. + +=item B<-ut>|B<+ut> + +Compile I<utmp>: Inhibit/enable writing a utmp entry; resource +B<utmpInhibit>. + +=item B<-vb>|B<+vb> + +Turn on/off visual bell on receipt of a bell character; resource +B<visualBell>. + +=item B<-sb>|B<+sb> + +Turn on/off scrollbar; resource B<scrollBar>. + +=item B<-si>|B<+si> + +Turn on/off scroll-to-bottom on TTY output inhibit; resource +B<scrollTtyOutput> has opposite effect. + +=item B<-sk>|B<+sk> + +Turn on/off scroll-to-bottom on keypress; resource +B<scrollTtyKeypress>. + +=item B<-sw>|B<+sw> + +Turn on/off scrolling with the scrollback buffer as new lines appear. +This only takes effect if B<-si> is also given; resource +B<scrollWithBuffer>. + +=item B<-sr>|B<+sr> + +Put scrollbar on right/left; resource B<scrollBar_right>. + +=item B<-st>|B<+st> + +Display normal (non XTerm/NeXT) scrollbar without/with a trough; +resource B<scrollBar_floating>. + +=item B<-bc>|B<+bc> + +Blink the cursor; resource B<cursorBlink>. + +=item B<-iconic> + +Start iconified, if the window manager supports that option. +Alternative form is B<-ic>. + +=item B<-sl> I<number> + +Save I<number> lines in the scrollback buffer. See resource entry for +limits; resource B<saveLines>. + +=item B<-b> I<number> + +Compile I<frills>: Internal border of I<number> pixels. See resource +entry for limits; resource B<internalBorder>. + +=item B<-w> I<number> + +Compile I<frills>: External border of I<number> pixels. Also, B<-bw> +and B<-borderwidth>. See resource entry for limits; resource +B<externalBorder>. + +=item B<-bl> + +Compile I<frills>: Set MWM hints to request a borderless window, i.e. +if honoured by the WM, the rxvt window will not have window +decorations; resource B<borderLess>. + +=item B<-lsp> I<number> + +Compile I<linespace>: Lines (pixel height) to insert between each row +of the display; resource B<linespace>. + +=item B<-tn> I<termname> + +This option specifies the name of the terminal type to be set in the +B<TERM> environment variable. This terminal type must exist in the +I<termcap(5)> database and should have I<li#> and I<co#> entries; +resource B<termName>. + +=item B<-e> I<command [arguments]> + +Run the command with its command-line arguments in the B<@@RXVTNAME@@> +window; also sets the window title and icon name to be the basename of +the program being executed if neither I<-title> (I<-T>) nor I<-n> are +given on the command line. If this option is used, it must be the last +on the command-line. If there is no B<-e> option then the default is to +run the program specified by the B<SHELL> environment variable or, +failing that, I<sh(1)>. + +=item B<-title> I<text> + +Window title (B<-T> still respected); the default title is the basename +of the program specified after the B<-e> option, if any, otherwise the +application name; resource B<title>. + +=item B<-n> I<text> + +Icon name; the default name is the basename of the program specified +after the B<-e> option, if any, otherwise the application name; +resource B<iconName>. + +=item B<-C> + +Capture system console messages. + +=item B<-pt> I<style> + +Compile I<XIM>: input style for input method; B<OverTheSpot>, +B<OffTheSpot>, B<Root>; resource B<preeditType>. + +=item B<-im> I<text> + +Compile I<XIM>: input method name. resource B<inputMethod>. + +=item B<-imlocale> I<string> + +The locale to use for opening the IM. You can use an LC_CTYPE of e.g. +de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input +extension to be able to input japanese characters while staying in +another locale. + +=item B<-insecure> + +Enable "insecure" mode, which currently enables most of the escape +sequences that echo strings. See the resource B<insecure> for more +info. + +=item B<-mod> I<modifier> + +Override detection of Meta modifier with specified key: B<alt>, +B<meta>, B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, +B<mod5>; resource I<modifier>. + +=item B<-ssc>|B<+ssc> + +Turn on/off secondary screen (default enabled); resource +B<secondaryScreen>. + +=item B<-ssr>|B<+ssr> + +Turn on/off secondary screen scroll (default enabled); resource +B<secondaryScroll>. + +=item B<-xrm> I<resourcestring> + +No effect on rxvt. Simply passes through an argument to be made +available in the instance's argument list. Appears in I<WM_COMMAND> in +some window managers. + +=back + +=head1 RESOURCES (available also as long-options) + +Note: `@@RXVTNAME@@ --help' gives a list of all resources (long +options) compiled into your version. + +There are two different methods that @@RXVTNAME@@ can use to get the +Xresource data: using the X libraries (Xrm*-functions) or internal +Xresources reader (B<~/.Xdefaults>). For the first method (ie. +B<@@RXVTNAME@@ -h> lists B<XGetDefaults>), you can set and change the +resources using X11 tools like B<xset>. Many distribution do also load +settings from the B<~/.Xresources> file when X starts. + +If compiled with internal Xresources support (i.e. B<@@RXVTNAME@@ -h> +lists B<.Xdefaults>) then B<@@RXVTNAME@@> accepts application defaults +set in XAPPLOADDIR/URxvt (compile-time defined: usually +B</usr/lib/X11/app-defaults/URxvt>) and resources set in +B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. +Note that when reading X resources, B<@@RXVTNAME@@> recognizes two +class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows +resources common to both B<@@RXVTNAME@@> and the original I<rxvt> to be +easily configured, while the class name B<URxvt> allows resources +unique to B<@@RXVTNAME@@>, notably colours and key-handling, to be +shared between different B<@@RXVTNAME@@> configurations. If no +resources are specified, suitable defaults will be used. Command-line +arguments can be used to override resource settings. The following +resources are allowed: + +=over 4 + +=item B<geometry:> I<geom> + +Create the window with the specified X window geometry [default 80x24]; +option B<-geometry>. + +=item B<background:> I<colour> + +Use the specified colour as the window's background colour [default +White]; option B<-bg>. + +=item B<foreground:> I<colour> + +Use the specified colour as the window's foreground colour [default +Black]; option B<-fg>. + +=item B<color>I<n>B<:> I<colour> + +Use the specified colour for the colour value I<n>, where 0-7 +corresponds to low-intensity (normal) colours and 8-15 corresponds to +high-intensity (bold = bright foreground, blink = bright background) +colours. The canonical names are as follows: 0=black, 1=red, 2=green, +3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour +names used are listed in the B<COLORS AND GRAPHICS> section. + +=item B<colorBD:> I<colour> + +Use the specified colour to display bold characters when the foreground +colour is the default. This option will be ignored if B<realBold> is +enabled. + +=item B<colorUL:> I<colour> + +Use the specified colour to display underlined characters when the +foreground colour is the default. + +=item B<colorRV:> I<colour> + +Use the specified colour as the background for reverse video +characters. + +=item B<cursorColor:> I<colour> + +Use the specified colour for the cursor. The default is to use the +foreground colour; option B<-cr>. + +=item B<cursorColor2:> I<colour> + +Use the specified colour for the colour of the cursor text. For this to +take effect, B<cursorColor> must also be specified. The default is to +use the background colour. + +=item B<reverseVideo:> I<boolean> + +B<True>: simulate reverse video by foreground and background colours; +option B<-rv>. B<False>: regular screen colours [default]; option +B<+rv>. See note in B<COLORS AND GRAPHICS> section. + +=item B<jumpScroll:> I<boolean> + +B<True>: specify that jump scrolling should be used. When scrolling +quickly, fewer screen updates are performed [default]; option B<-j>. +B<False>: specify that smooth scrolling should be used; option B<+j>. + +=item B<inheritPixmap:> I<boolean> + +B<True>: make the background inherit the parent windows' pixmap, giving +artificial transparency. B<False>: do not inherit the parent windows' +pixmap. + +=item B<fading:> I<number> + +Fade the text by the given percentage when focus is lost. + +=item B<tintColor:> I<colour> + +Tint the transparent background pixmap with the given colour. + +=item B<shading:> I<number> + +Darken (0 .. 100) or lighten (-1 .. -100) the transparent background +image in addition to tinting it. + +=item B<fading:> I<number> + +Scale the tint colour by the given percentage. + +=item B<scrollColor:> I<colour> + +Use the specified colour for the scrollbar [default #B2B2B2]. + +=item B<troughColor:> I<colour> + +Use the specified colour for the scrollbar's trough area [default +#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. + +=item B<backgroundPixmap:> I<file[;geom]> + +Use the specified XPM file (note the `.xpm' extension is optional) for +the background and also optionally specify its scaling with a geometry +string B<WxH+X+Y>, in which B<"W" / "H"> specify the +horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image +centre (percent). A scale of 0 displays the image with tiling. A scale +of 1 displays the image without any scaling. A scale of 2 to 9 +specifies an integer number of images in that direction. No image will +be magnified beyond 10 times its original size. The maximum permitted +scale is 1000. [default 0x0+50+50] + +=item B<menu:> I<file[;tag]> + +Read in the specified menu file (note the `.menu' extension is +optional) and also optionally specify a starting tag to find. See the +reference documentation for details on the syntax for the menuBar. + +=item B<path:> I<path> + +Specify the colon-delimited search path for finding files (XPM and +menus), in addition to the paths specified by the B<RXVTPATH> and +B<PATH> environment variables. + +=item B<font:> I<fontname> + +Select the fonts to be used. This is a comma seperated list of font +names that are used in turn when trying to display Unicode characters. +The first font defines the cell size for characters; other fonts might +be smaller, but not larger. A reasonable default font list is always +appended to it. option B<-fn>. + +=item B<realBold:> I<boolean> + +B<True>: Enable "real bold" support. When this option is on, bold text +will be displayed using the first available bold font in the font list. +Bold fonts should thus be specified in the font list after their +corresponding regular fonts. If no bold font can be found, a regular +font will be used. option B<-rb>. B<False>: Display bold text in a +regular font, using the color specified with B<colorBD>; option B<+rb>. + +=item B<selectstyle:> I<mode> + +Set mouse selection style to B<old> which is 2.20, B<oldword> which is +xterm style with 2.20 old word selection, or anything else which gives +xterm style selection. + +=item B<scrollstyle:> I<mode> + +Set scrollbar style to B<@@RXVTNAME@@>, B<rxvt>, B<plain>, B<next> or +B<xterm> + +=item B<title:> I<string> + +Set window title string, the default title is the command-line +specified after the B<-e> option, if any, otherwise the application +name; option B<-title>. + +=item B<iconName:> I<string> + +Set the name used to label the window's icon or displayed in an icon +manager window, it also sets the window's title unless it is explicitly +set; option B<-n>. + +=item B<mapAlert:> I<boolean> + +B<True>: de-iconify (map) on receipt of a bell character. B<False>: no +de-iconify (map) on receipt of a bell character [default]. + +=item B<visualBell:> I<boolean> + +B<True>: use visual bell on receipt of a bell character; option B<-vb>. +B<False>: no visual bell [default]; option B<+vb>. + +=item B<loginShell:> I<boolean> + +B<True>: start as a login shell by prepending a `-' to B<argv[0]> of +the shell; option B<-ls>. B<False>: start as a normal sub-shell +[default]; option B<+ls>. + +=item B<utmpInhibit:> I<boolean> + +B<True>: inhibit writing record into the system log file B<utmp>; +option B<-ut>. B<False>: write record into the system log file B<utmp> +[default]; option B<+ut>. + +=item B<print-pipe:> I<string> + +Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use +B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or +B<Shift-Print> to include the scrollback as well. + +=item B<scrollBar:> I<boolean> + +B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: +disable the scrollbar; option B<+sb>. + +=item B<scrollBar_right:> I<boolean> + +B<True>: place the scrollbar on the right of the window; option B<-sr>. +B<False>: place the scrollbar on the left of the window; option B<+sr>. + +=item B<scrollBar_floating:> I<boolean> + +B<True>: display an rxvt scrollbar without a trough; option B<-st>. +B<False>: display an rxvt scrollbar with a trough; option B<+st>. + +=item B<scrollBar_align:> I<mode> + +Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar +thumb with the pointer on middle button press/drag. + +=item B<scrollTtyOutput:> I<boolean> + +B<True>: scroll to bottom when tty receives output; option B<+si>. +B<False>: do not scroll to bottom when tty receives output; option +B<-si>. + +=item B<scrollWithBuffer:> I<boolean> + +B<True>: scroll with scrollback buffer when tty recieves new lines (and +B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll +with scrollback buffer when tty recieves new lines; option B<-sw>. + +=item B<scrollTtyKeypress:> I<boolean> + +B<True>: scroll to bottom when a non-special key is pressed. Special +keys are those which are intercepted by rxvt for special handling and +are not passed onto the shell; option B<-sk>. B<False>: do not scroll +to bottom when a non-special key is pressed; option B<+sk>. + +=item B<smallfont_key:> I<keysym> + +If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a smaller font +[default B<@@HOTKEY@@-@@SMALLFONT@@>] + +=item B<bigfont_key:> I<keysym> + +If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a bigger font +[default B<@@HOTKEY@@-@@BIGFONT@@>] + +=item B<saveLines:> I<number> + +Save I<number> lines in the scrollback buffer [default 64]. This +resource is limited on most machines to 65535; option B<-sl>. + +=item B<internalBorder:> I<number> + +Internal border of I<number> pixels. This resource is limited to 100; +option B<-b>. + +=item B<externalBorder:> I<number> + +External border of I<number> pixels. This resource is limited to 100; +option B<-w>, B<-bw>, B<-borderwidth>. + +=item B<borderLess:> I<boolean> + +Set MWM hints to request a borderless window, i.e. if honoured by the +WM, the rxvt window will not have window decorations; option B<-bl>. + +=item B<termName:> I<termname> + +Specifies the terminal type name to be set in the B<TERM> environment +variable; option B<-tn>. + +=item B<linespace:> I<number> + +Specifies number of lines (pixel height) to insert between each row of +the display [default 0]; option B<-lsp>. + +=item B<meta8:> I<boolean> + +B<True>: handle Meta (Alt) + keypress to set the 8th bit. B<False>: +handle Meta (Alt) + keypress as an escape prefix [default]. + +=item B<mouseWheelScrollPage:> I<boolean> + +B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel +scrolls five lines [default]. + +=item B<cursorBlink:> I<boolean> + +B<True>: blink the cursor. B<False>: do not blink the cursor [default]; +option B<-bc>. + +=item B<pointerBlank:> I<boolean> + +B<True>: blank the pointer when a key is pressed or after a set number +of seconds of inactivity. B<False>: the pointer is always visible +[default]. + +=item B<pointerColor:> I<colour> + +Mouse pointer foreground colour. + +=item B<pointerColor2:> I<colour> + +Mouse pointer background colour. + +=item B<pointerBlankDelay:> I<number> + +Specifies number of seconds before blanking the pointer [default 2]. + +=item B<backspacekey:> I<string> + +The string to send when the backspace key is pressed. If set to B<DEC> +or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> +(code 8) - which can be reversed with the appropriate DEC private mode +escape sequence. + +=item B<deletekey:> I<string> + +The string to send when the delete key (not the keypad delete key) is +pressed. If unset it will send the sequence traditionally associated +with the B<Execute> key. + +=item B<cutchars:> I<string> + +The characters used as delimiters for double-click word selection. The +built-in default: + +B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> + +=item B<preeditType:> I<style> + +B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. + +=item B<inputMethod:> I<name> + +I<name> of inputMethod to use; option B<-im>. + +=item B<imLocale:> I<name> + +The locale to use for opening the IM. You can use an LC_CTYPE of e.g. +de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input +extension to be able to input japanese characters while staying in +another locale. option B<-imlocale>. + +=item B<insecure> + +Enables "insecure" mode. Rxvt-unicode offers some escape sequences that +echo arbitrary strings like the icon name or the locale. This could be +abused if somebody gets 8-bit-clean access to your display, wether +throuh a mail client displaying mail bodies unfiltered or though +write(1). Therefore, these sequences are disabled by default. (Note +that other terminals, including xterm, have these sequences +enabled by default). You can enable them by setting this boolean +resource or specifying B<-insecure> as an option. At the moment, this +enabled display-answer, locale, findfont, icon label and window title +requests as well as dynamic menubar dispatch. + +=item B<modifier:> I<modifier> + +Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, +B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option +B<-mod>. + +=item B<answerbackString:> I<string> + +Specify the reply rxvt sends to the shell when an ENQ (control-E) +character is passed through. It may contain escape values as described +in the entry on B<keysym> following. + +=item B<secondaryScreen:> I<bool> + +Turn on/off secondary screen (default enabled). + +=item B<secondaryScroll:> I<bool> + +Turn on/off secondary screen scroll (default enabled). If the this +option is enabled, scrolls on the secondary screen will change the +scrollback buffer and switching to/from the secondary screen will +instead scroll the screen up. + +=item B<keysym.>I<sym>: I<string> + +Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may +contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: +newline, \r: return, \t: +tab, \000: octal number) or control characters (^?: delete, ^@: null, +^A ...) and may enclosed with double quotes so that it can start or end +with whitespace. The intervening resource name B<keysym.> cannot be +omitted. This resource is only available when compiled with +KEYSYM_RESOURCE. + +=back + +=head1 THE SCROLLBAR + +Lines of text that scroll off the top of the B<@@RXVTNAME@@> window +(resource: B<saveLines>) and can be scrolled back using the scrollbar +or by keystrokes. The normal B<@@RXVTNAME@@> scrollbar has arrows and +its behaviour is fairly intuitive. The B<xterm-scrollbar> is without +arrows and its behaviour mimics that of I<xterm> + +Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>. +Scroll up with B<Button3> (B<xterm-scrollbar>) or B<Shift-Prior>. +Continuous scroll with B<Button2>. + +=head1 MOUSE REPORTING + +To temporarily override mouse reporting, for either the scrollbar or +the normal text selection/insertion, hold either the Shift or the Meta +(Alt) key while performing the desired mouse action. + +If mouse reporting mode is active, the normal scrollbar actions are +disabled -- on the assumption that we are using a fullscreen +application. Instead, pressing Button1 and Button3 sends B<ESC[6~> +(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the +up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), +respectively. + +=head1 TEXT SELECTION AND INSERTION + +The behaviour of text selection and insertion mechanism is similar to +I<xterm>(1). + +=over 4 + +=item B<Selection>: + +Left click at the beginning of the region, drag to the end of the +region and release; Right click to extend the marked region; Left +double-click to select a word; Left triple-click to select the entire +line. + +=item B<Insertion>: + +Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in +an B<@@RXVTNAME@@> window causes the current text selection to be +inserted as if it had been typed on the keyboard. + +=back + +=head1 CHANGING FONTS + +You can change fonts on-the-fly, which is to say cycle through the +default font and others of various sizes, by using B<Shift-KP_Add> and +B<Shift-KP_Subtract>. Or, alternatively (if enabled) with +B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the +actual key can be selected using resources +B<smallfont_key>/B<bigfont_key>. + +=head1 LOGIN STAMP + +B<@@RXVTNAME@@> tries to write an entry into the I<utmp>(5) file so +that it can be seen via the I<who(1)> command, and can accept messages. +To allow this feature, B<@@RXVTNAME@@> must be installed setuid root on +some systems. + +=head1 COLORS AND GRAPHICS + +In addition to the default foreground and background colours, +B<@@RXVTNAME@@> can display up to 16 colours (8 ANSI colours plus +high-intensity bold/blink versions of the same). Here is a list of the +colours with their B<rgb.txt> names. + +=begin table + + B<color0> (black) = Black + B<color1> (red) = Red3 + B<color2> (green) = Green3 + B<color3> (yellow) = Yellow3 + B<color4> (blue) = Blue3 + B<color5> (magenta) = Magenta3 + B<color6> (cyan) = Cyan3 + B<color7> (white) = AntiqueWhite + B<color8> (bright black) = Grey25 + B<color9> (bright red) = Red + B<color10> (bright green) = Green + B<color11> (bright yellow) = Yellow + B<color12> (bright blue) = Blue + B<color13> (bright magenta) = Magenta + B<color14> (bright cyan) = Cyan + B<color15> (bright white) = White + B<foreground> = Black + B<background> = White + +=end table + +It is also possible to specify the colour values of B<foreground>, +B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as +a number 0-15, as a convenient shorthand to reference the colour name of +color0-color15. + +Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by +always swapping the foreground/background colours. This is in contrast to +I<xterm>(1) where the colours are only swapped if they have not otherwise +been specified. For example, + +=over 4 + +=item B<rxvt -fg Black -bg White -rv> + +would yield White on Black, while on I<xterm>(1) it would yield Black +on White. + +=back + +=head1 ENVIRONMENT + +B<@@RXVTNAME@@> sets the environment variables B<TERM>, B<COLORTERM> +and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X +window id number of the B<@@RXVTNAME@@> window and it also uses and +sets the environment variable B<DISPLAY> to specify which display +terminal to use. B<@@RXVTNAME@@> uses the environment variables +B<RXVTPATH> and B<PATH> to find XPM files. + +=head1 FILES + +=over 4 + +=item B</etc/utmp> + +System file for login records. + +=item B</usr/lib/X11/rgb.txt> + +Color names. + +=back + +=head1 SEEALSO + +I<xterm>(1), I<sh>(1), I<resize>(1), I<X>(1), I<pty>(4), I<tty>(4), I<utmp>(5) + +See rxvtRef.html rxvtRef.txt for detailed information on recognized escape sequences and menuBar syntax, etc. + +=head1 BUGS + +Check the BUGS file for an up-to-date list. + +Cursor change support is not yet implemented. + +Click-and-drag doesn't work with X11 mouse report overriding. + +=head1 FTP LOCATION + +rxvt-+@@RXVTVERSION@@.tar.gz can be found at the following ftp sites L<@@RXVTFTPSITE@@>(@@RXVTFTPSITE@@) + +=head1 CURRENT PROJECT COORDINATOR + +=over 4 + +=item Project Coordinator + +@@RXVTMAINT@@ L<@@RXVTMAINTEMAIL@@> + +=item Web page maintainter + +@@RXVTWEBMAINT@@ L<@@RXVTWEBMAINTEMAIL@@> + +L<@@RXVTWEBPAGE@@>(@@RXVTWEBPAGE@@) + +=back + +=head1 AUTHORS + +=over 4 + +=item John Bovey + +University of Kent, 1992, wrote the original Xvt. + +=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> + +very heavily modified Xvt and came up with Rxvt + +=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> + +wrote the Greek Keyboard Input (no longer in code) + +=item mj olesen L<< <olesen@me.QueensU.CA> >> + +Wrote the menu system. + +Project Coordinator (changes.txt 2.11 to 2.21) + +=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> + +Project Coordinator (changes.txt 2.21a to 2.4.5) + +=item Geoff Wing L<< <gcw@pobox.com> >> + +Rewrote screen display and text selection routines. Project Coordinator +(changes.txt 2.4.6 - rxvt-unicode) + +=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> + +Forked rxvt-unicode, rewrote most of the display code and internal +character handling to store text in unicode, improve xterm +compatibility and apply numerous other bugfixes and extensions. + +Project Coordinator (Changes 1.0 -) + +=back + diff --git a/doc/rxvt.7.pod b/doc/rxvt.7.pod new file mode 100644 index 0000000000000000000000000000000000000000..9e92abb06022eb36ca616732d361781bd05c8840 --- /dev/null +++ b/doc/rxvt.7.pod @@ -0,0 +1,1412 @@ +=head1 Rxvt Technical Reference + +Marc Lehmann <rxvt@schmorp.de>, converted to pod and reworked from the +original Rxvt documentation by Geoff Wing <gcw@pobox.com>, who in turn used +the XTerm documentation and other sources. + +=head1 Definitions + +=over 4 + +=item B<< C<c> >> + +The literal character c. + +=item B<< C<C> >> + +A single (required) character. + +=item B<< C<Ps> >> + +A single (usually optional) numeric parameter, composed of one or more +digits. + +=item B<< C<Pm> >> + +A multiple numeric parameter composed of any number of single numeric +parameters, separated by C<;> character(s). + +=item B<< C<Pt> >> + +A text parameter composed of printable characters. + +=back + +=head1 Values + +=over 4 + +=item B<< C<ENQ> >> + +Enquiry (Ctrl-E) = Send Device Attributes (DA) +request attributes from terminal == + +=item B<< C<BEL> >> + +Bell (Ctrl-G) + +=item B<< C<BS> >> + +Backspace (Ctrl-H) + +=item B<< C<TAB> >> + +Horizontal Tab (HT) (Ctrl-I) + +=item B<< C<LF> >> + +Line Feed or New Line (NL) (Ctrl-J) + +=item B<< C<VT> >> + +Vertical Tab (Ctrl-K) same as B<< C<LF> >> + +=item B<< C<FF> >> + +Form Feed or New Page (NP) (Ctrl-L) same as B<< C<LF> >> + +=item B<< C<CR> >> + +Carriage Return (Ctrl-M) + +=item B<< C<SO> >> + +Shift Out (Ctrl-N), invokes the G1 character set. +Switch to Alternate Character Set + +=item B<< C<SI> >> + +Shift In (Ctrl-O), invokes the G0 character set (the default). +Switch to Standard Character Set + +=item B<< C<SPC> >> + +Space Character + +=back + +=head1 Escape Sequences + +=over 4 + +=item B<< C<ESC # 8> >> + +DEC Screen Alignment Test (DECALN) + +=item B<< C<ESC 7> >> + +Save Cursor (SC) + +=item B<< C<ESC 8> >> + +Restore Cursor + +=item B<< C<ESC => >> + +Application Keypad (SMKX). See also next sequence. + +=item B<<< C<< ESC >> >>> + +Normal Keypad (RMKX) + +B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been +pressed, numbers or control functions are generated by the numeric keypad +(see Key Codes). + +=item B<< C<ESC D> >> + +Index (IND) + +=item B<< C<ESC E> >> + +Next Line (NEL) + +=item B<< C<ESC H> >> + +Tab Set (HTS) + +=item B<< C<ESC M> >> + +Reverse Index (RI) + +=item B<< C<ESC N> >> + +Single Shift Select of G2 Character Set (SS2): affects next character +only I<unimplemented> + +=item B<< C<ESC O> >> + +Single Shift Select of G3 Character Set (SS3): affects next character +only I<unimplemented> + +=item B<< C<ESC Z> >> + +Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt compile-time option> + +=item B<< C<ESC c> >> + +Full reset (RIS) + +=item B<< C<ESC n> >> + +Invoke the G2 Character Set (LS2) + +=item B<< C<ESC o> >> + +Invoke the G3 Character Set (LS3) + +=item B<< C<ESC>(C<C> >> + +Designate G0 Character Set (ISO 2022), see below for values of C<C>. + +=item B<< C<ESC>)C<C> >> + +Designate G1 Character Set (ISO 2022), see below for values of C<C>. + +=item B<< C<ESC * C> >> + +Designate G2 Character Set (ISO 2022), see below for values of C<C>. + +=item B<< C<ESC + C> >> + +Designate G3 Character Set (ISO 2022), see below for values of C<C>. + +=item B<< C<ESC $ C> >> + +Designate Kanji Character Set + +Where B<< C<C> >> is one of: + +=begin table + + C = C<0> DEC Special Character and Line Drawing Set + C = C<A> United Kingdom (UK) + C = C<B> United States (USASCII) + C = C<< < >> Multinational character set I<unimplemented> + C = C<5> Finnish character set I<unimplemented> + C = C<C> Finnish character set I<unimplemented> + C = C<K> German character set I<unimplemented> + +=end table + +=back + +X<CSI> + +=head1 CSI (Code Sequence Introducer) Sequences + +=over 4 + +=item B<< C<ESC [ Ps @> >> + +Insert B<< C<Ps> >> (Blank) Character(s) [default: 1] (ICH)X<ESCOBPsA> + +=item B<< C<ESC [ Ps A> >> + +Cursor Up B<< C<Ps> >> Times [default: 1] (CUU) + +=item B<< C<ESC [ Ps B> >> + +Cursor Down B<< C<Ps> >> Times [default: 1] (CUD)X<ESCOBPsC> + +=item B<< C<ESC [ Ps C> >> + +Cursor Forward B<< C<Ps> >> Times [default: 1] (CUF) + +=item B<< C<ESC [ Ps D> >> + +Cursor Backward B<< C<Ps> >> Times [default: 1] (CUB) + +=item B<< C<ESC [ Ps E> >> + +Cursor Down B<< C<Ps> >> Times [default: 1] and to first column + +=item B<< C<ESC [ Ps F> >> + +Cursor Up B<< C<Ps> >> Times [default: 1] and to first columnX<ESCOBPsG> + +=item B<< C<ESC [ Ps G> >> + +Cursor to Column B<< C<Ps> >> (HPA) + +=item B<< C<ESC [ Ps;Ps H> >> + +Cursor Position [row;column] [default: 1;1] (CUP) + +=item B<< C<ESC [ Ps I> >> + +Move forward B<< C<Ps> >> tab stops [default: 1] + +=item B<< C<ESC [ Ps J> >> + +Erase in Display (ED) + +=begin table + + B<< C<Ps = 0> >> Clear Below (default) + B<< C<Ps = 1> >> Clear Above + B<< C<Ps = 2> >> Clear All + +=end table + +=item B<< C<ESC [ Ps K> >> + +Erase in Line (EL) + +=begin table + + B<< C<Ps = 0> >> Clear to Right (default) + B<< C<Ps = 1> >> Clear to Left + B<< C<Ps = 2> >> Clear All + +=end table + +=item B<< C<ESC [ Ps L> >> + +Insert B<< C<Ps> >> Line(s) [default: 1] (IL) + +=item B<< C<ESC [ Ps M> >> + +Delete B<< C<Ps> >> Line(s) [default: 1] (DL) + +=item B<< C<ESC [ Ps P> >> + +Delete B<< C<Ps> >> Character(s) [default: 1] (DCH) + +=item B<< C<ESC [ Ps;Ps;Ps;Ps;Ps T> >> + +Initiate . I<unimplemented> Parameters are +[func;startx;starty;firstrow;lastrow]. + +=item B<< C<ESC [ Ps W> >> + +Tabulator functions + +=begin table + + B<< C<Ps = 0> >> Tab Set (HTS) + B<< C<Ps = 2> >> Tab Clear (TBC), Clear Current Column (default) + B<< C<Ps = 5> >> Tab Clear (TBC), Clear All + +=end table + +=item B<< C<ESC [ Ps X> >> + +Erase B<< C<Ps> >> Character(s) [default: 1] (ECH) + +=item B<< C<ESC [ Ps Z> >> + +Move backward B<< C<Ps> >> [default: 1] tab stops + +=item B<< C<ESC [ Ps '> >> + +== + +=item B<< C<ESC [ Ps a> >> + +==X<ESCOBPsc> + +=item B<< C<ESC [ Ps c> >> + +Send Device Attributes (DA) +B<< C<Ps = 0> >> (or omitted): request attributes from terminal +returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video +Option'') + +=item B<< C<ESC [ Ps d> >> + +Cursor to Line B<< C<Ps> >> (VPA) + +=item B<< C<ESC [ Ps e> >> + +== + +=item B<< C<ESC [ Ps;Ps f> >> + +Horizontal and Vertical Position [row;column] (HVP) [default: 1;1] + +=item B<< C<ESC [ Ps g> >> + +Tab Clear (TBC) + +=begin table + + B<< C<Ps = 0> >> Clear Current Column (default) + B<< C<Ps = 3> >> Clear All (TBC) + +=end table + +=item B<< C<ESC [ Ps i> >> + +Printing + +=begin table + + B<< C<Ps = 4> >> disable transparent print mode (MC4) + B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented> + +=end table + +=item B<< C<ESC [ Pm h> >> + +Set Mode (SM). See next sequence for description of C<Pm>. + +=item B<< C<ESC [ Pm l> >> + +Reset Mode (RM) + +=over 4 + +=item B<< C<Ps = 4> >> + +=begin table + + B<< C<h> >> Insert Mode (SMIR) + B<< C<l> >> Replace Mode (RMIR) + +=end table + +=item B<< C<Ps = 20> >> I<unimplemented> + +=begin table + + B<< C<h> >> Automatic Newline (LNM) + B<< C<h> >> Normal Linefeed (LNM) + +=end table + +=back + +=item B<< C<ESC [ Pm m> >> + +Character Attributes (SGR) + +=begin table + + B<< C<Ps = 0> >> Normal (default) + B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg) + B<< C<Ps = 4 / 24> >> On / Off Underline + B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg) + B<< C<Ps = 7 / 27> >> On / Off Inverse + B<< C<Ps = 30 / 40> >> fg/bg Black + B<< C<Ps = 31 / 41> >> fg/bg Red + B<< C<Ps = 32 / 42> >> fg/bg Green + B<< C<Ps = 33 / 43> >> fg/bg Yellow + B<< C<Ps = 34 / 44> >> fg/bg Blue + B<< C<Ps = 35 / 45> >> fg/bg Magenta + B<< C<Ps = 36 / 46> >> fg/bg Cyan + B<< C<Ps = 37 / 47> >> fg/bg White + B<< C<Ps = 39 / 49> >> fg/bg Default + +=end table + +=item B<< C<ESC [ Ps n> >> + +Device Status Report (DSR) + +=begin table + + B<< C<Ps = 5> >> Status Report B<< C<ESC [ 0 n> >> (``OK'') + B<< C<Ps = 6> >> Report Cursor Position (CPR) [row;column] as B<< C<ESC [ r ; c R> >> + B<< C<Ps = 7> >> Request Display Name + B<< C<Ps = 8> >> Request Version Number (place in window title) + +=end table + +=item B<< C<ESC [ Ps;Ps r> >> + +Set Scrolling Region [top;bottom] +[default: full size of window] (CSR) + +=item B<< C<ESC [ s> >> + +Save Cursor (SC) + +=item B<< C<ESC [ Ps x> >> + +Request Terminal Parameters (DECREQTPARM) + +=item B<< C<ESC [ u> >> + +Restore Cursor + +=back + +X<PrivateModes> + +=head1 DEC Private Modes + +=over 4 + +=item B<< C<ESC [ ? Pm h> >> + +DEC Private Mode Set (DECSET) + +=item B<< C<ESC [ ? Pm l> >> + +DEC Private Mode Reset (DECRST) + +=item B<< C<ESC [ ? Pm r> >> + +Restore previously saved DEC Private Mode Values. + +=item B<< C<ESC [ ? Pm s> >> + +Save DEC Private Mode Values. + +=item B<< C<ESC [ ? Pm t> >> + +Toggle DEC Private Mode Values (rxvt extension). I<where> + +=over 4 + +=item B<< C<Ps = 1> >> (DECCKM) + +=begin table + + B<< C<h> >> Application Cursor Keys + B<< C<l> >> Normal Cursor Keys + +=end table + +=item B<< C<Ps = 2> >> (ANSI/VT52 mode) + +=begin table + + B<< C<h> >> Enter VT52 mode + B<< C<l> >> Enter VT52 mode + +=end table + +=item B<< C<Ps = 3> >> + +=begin table + + B<< C<h> >> 132 Column Mode (DECCOLM) + B<< C<l> >> 80 Column Mode (DECCOLM) + +=end table + +=item B<< C<Ps = 4> >> + +=begin table + + B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) + B<< C<l> >> Jump (Fast) Scroll (DECSCLM) + +=end table + +=item B<< C<Ps = 5> >> + +=begin table + + B<< C<h> >> Reverse Video (DECSCNM) + B<< C<l> >> Normal Video (DECSCNM) + +=end table + +=item B<< C<Ps = 6> >> + +=begin table + + B<< C<h> >> Origin Mode (DECOM) + B<< C<l> >> Normal Cursor Mode (DECOM) + +=end table + +=item B<< C<Ps = 7> >> + +=begin table + + B<< C<h> >> Wraparound Mode (DECAWM) + B<< C<l> >> No Wraparound Mode (DECAWM) + +=end table + +=item B<< C<Ps = 8> >> I<unimplemented> + +=begin table + + B<< C<h> >> Auto-repeat Keys (DECARM) + B<< C<l> >> No Auto-repeat Keys (DECARM) + +=end table + +=item B<< C<Ps = 9> >> X10 XTerm + +=begin table + + B<< C<h> >> Send Mouse X & Y on button press. + B<< C<l> >> No mouse reporting. + +=end table + +)X<Priv10> + +=item B<< C<Ps = 10> >> (B<rxvt>) + +=begin table + + B<< C<h> >> visible + B<< C<l> >> invisible + +=end table + +=item B<< C<Ps = 25> >> + +=begin table + + B<< C<h> >> Visible cursor {cnorm/cvvis} + B<< C<l> >> Invisible cursor {civis} + +=end table + +=item B<< C<Ps = 30> >> + +=begin table + + B<< C<h> >> scrollBar visisble + B<< C<l> >> scrollBar invisisble + +=end table + +=item B<< C<Ps = 35> >> (B<rxvt>) + +=begin table + + B<< C<h> >> Allow XTerm Shift+key sequences + B<< C<l> >> Disallow XTerm Shift+key sequences + +=end table + +=item B<< C<Ps = 38> >> I<unimplemented> + +Enter Tektronix Mode (DECTEK) + +=item B<< C<Ps = 40> >> + +=begin table + + B<< C<h> >> Allow 80/132 Mode + B<< C<l> >> Disallow 80/132 Mode + +=end table + +=item B<< C<Ps = 44> >> I<unimplemented> + +=begin table + + B<< C<h> >> Turn On Margin Bell + B<< C<l> >> Turn Off Margin Bell + +=end table + +=item B<< C<Ps = 45> >> I<unimplemented> + +=begin table + + B<< C<h> >> Reverse-wraparound Mode + B<< C<l> >> No Reverse-wraparound Mode + +=end table + +=item B<< C<Ps = 46> >> I<unimplemented> + +=item B<< C<Ps = 47> >> + +=begin table + + B<< C<h> >> Use Alternate Screen Buffer + B<< C<l> >> Use Normal Screen Buffer + +=end table + +X<Priv66> + +=item B<< C<Ps = 66> >> + +=begin table + + B<< C<h> >> Application Keypad (DECPAM) == + B<< C<l> >> Normal Keypad (DECPNM) == + +=end table + +=item B<< C<Ps = 67> >> + +=begin table + + B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> + B<< C<l> >> Backspace key sends B<< C<DEL> >> + +=end table + +=item B<< C<Ps = 1000> >> (X11 XTerm) + +=begin table + + B<< C<h> >> Send Mouse X & Y on button press and release. + B<< C<l> >> No mouse reporting. + +=end table + +=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> + +=begin table + + B<< C<h> >> Use Hilite Mouse Tracking. + B<< C<l> >> No mouse reporting. + +=end table + +=item B<< C<Ps = 1010> >> + +=begin table + + B<< C<h> >> Don't scroll to bottom on TTY output + B<< C<l> >> Scroll to bottom on TTY output + +=end table + +=item B<< C<Ps = 1011> >> + +=begin table + + B<< C<h> >> Scroll to bottom when a key is pressed + B<< C<l> >> Don't scroll to bottom when a key is pressed + +=end table + +=item B<< C<Ps = 1047> >> + +=begin table + + B<< C<h> >> Use Alternate Screen Buffer + B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it + +=end table + +=item B<< C<Ps = 1048> >> + +=begin table + + B<< C<h> >> Save cursor position + B<< C<l> >> Restore cursor position + +=end table + +=back + +=back + +X<XTerm> + +=head1 XTerm Operating System Commands + +=over 4 + +=item B<< C<ESC ] Ps;Pt ST> >> + +Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \ (0x1b, +0x5c), backwards compatible terminator BEL (0x07) is also accepted. any +B<octet> can be escaped by prefixing it with SYN (0x16, ^V). + +=begin table + + B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> + B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> + B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> + B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property. + B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white + B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> + B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> + B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> + B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> + B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> + B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> + B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> + B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> + B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option> + B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> + B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> + B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> + B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> + B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVTNAME@@ extension) + B<< C<Ps = 702> >> find font for character, used for debugging (@@RXVTNAME@@ extension) + B<< C<Ps = 703> >> command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVTNAME@@ extension) + +=end table + +=back + +X<menuBar> + +=head1 menuBar + +B<< The exact syntax used is I<almost> solidified. >> +In the menus, B<DON'T> try to use menuBar commands that add or remove a +menuBar. + +Note that in all of the commands, the B<< I</path/> >> I<cannot> be +omitted: use B<./> to specify a menu relative to the current menu. + +=head2 Overview of menuBar operation + +For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax +of C<Pt> can be used for a variety of tasks: + +At the top level is the current menuBar which is a member of a circular +linked-list of other such menuBars. + +The menuBar acts as a parent for the various drop-down menus, which in +turn, may have labels, separator lines, menuItems and subMenus. + +The menuItems are the useful bits: you can use them to mimic keyboard +input or even to send text or escape sequences back to rxvt. + +The menuBar syntax is intended to provide a simple yet robust method of +constructing and manipulating menus and navigating through the +menuBars. + +The first step is to use the tag B<< [menu:I<name>] >> which creates +the menuBar called I<name> and allows access. You may now or menus, +subMenus, and menuItems. Finally, use the tag B<[done]> to set the +menuBar access as B<readonly> to prevent accidental corruption of the +menus. To re-access the current menuBar for alterations, use the tag +B<[menu]>, make the alterations and then use B<[done]> + +X<menuBarCommands> + +=head2 Commands + +=over 4 + +=item B<< [menu:+I<name>] >> + +access the named menuBar for creation or alteration. If a new menuBar +is created, it is called I<name> (max of 15 chars) and the current +menuBar is pushed onto the stack + +=item B<[menu]> + +access the current menuBar for alteration + +=item B<< [title:+I<string>] >> + +set the current menuBar's title to I<string>, which may contain the +following format specifiers: +B<%%> : literal B<%> character +B<%n> : rxvt name (as per the B<-name> command-line option) +B<%v> : rxvt version + +=item B<[done]> + +set menuBar access as B<readonly>. +End-of-file tag for B<< [read:+I<file>] >> operations. + +=item B<< [read:+I<file>] >> + +read menu commands directly from I<file> (extension ".menu" will be +appended if required.) Start reading at a line with B<[menu]> or B<< +[menu:+I<name> >> and continuing until B<[done]> is encountered. + +Blank and comment lines (starting with B<#>) are ignored. Actually, +since any invalid menu commands are also ignored, almost anything could +be construed as a comment line, but this may be tightened up in the +future ... so don't count on it!. + +=item B<< [read:+I<file>;+I<name>] >> + +The same as B<< [read:+I<file>] >>, but start reading at a line with +B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or +B<[done]> is encountered. + +=item B<[dump]> + +dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for +later rereading. + +=item B<[rm:name]> + +remove the named menuBar + +=item B<[rm] [rm:]> + +remove the current menuBar + +=item B<[rm*] [rm:*]> + +remove all menuBars + +=item B<[swap]> + +swap the top two menuBars + +=item B<[prev]> + +access the previous menuBar + +=item B<[next]> + +access the next menuBar + +=item B<[show]> + +Enable display of the menuBar + +=item B<[hide]> + +Disable display of the menuBar + +=item B<< [pixmap:+I<name>] >> + +=item B<< [pixmap:+I<name>;I<scaling>] >> + +(set the background pixmap globally + +B<< A Future implementation I<may> make this local to the menubar >>) + +=item B<< [:+I<command>:] >> + +ignore the menu readonly status and issue a I<command> to or a menu or +menuitem or change the ; a useful shortcut for setting the quick arrows +from a menuBar. + +=back + +X<menuBarAdd> + +=head2 Adding and accessing menus + +The following commands may also be B<+> prefixed. + +=over 4 + +=item B</+> + +access menuBar top level + +=item B<./+> + +access current menu level + +=item B<../+> + +access parent menu (1 level up) + +=item B<../../> + +access parent menu (multiple levels up) + +=item B<< I</path/>menu >> + +add/access menu + +=item B<< I</path/>menu/* >> + +add/access menu and clear it if it exists + +=item B<< I</path/>{-} >> + +add separator + +=item B<< I</path/>{item} >> + +add B<item> as a label + +=item B<< I</path/>{item} action >> + +add/alter I<menuitem> with an associated I<action> + +=item B<< I</path/>{item}{right-text} >> + +add/alter I<menuitem> with B<right-text> as the right-justified text +and as the associated I<action> + +=item B<< I</path/>{item}{rtext} action >> + +add/alter I<menuitem> with an associated I<action> and with B<rtext> as +the right-justified text. + +=back + +=over 4 + +=item Special characters in I<action> must be backslash-escaped: + +B<\a \b \E \e \n \r \t \octal> + +=item or in control-character notation: + +B<^@, ^A .. ^Z .. ^_, ^?> + +=back + +To send a string starting with a B<NUL> (B<^@>) character to the +program, start I<action> with a pair of B<NUL> characters (B<^@^@>), +the first of which will be stripped off and the balance directed to the +program. Otherwise if I<action> begins with B<NUL> followed by +non-+B<NUL> characters, the leading B<NUL> is stripped off and the +balance is sent back to rxvt. + +As a convenience for the many Emacs-type editors, I<action> may start +with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be +appended if missed from B<M-x> commands. + +As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or +quick arrow), a B<BEL> (B<^G>) will be appended if needed. + +=over 4 + +=item For example, + +B<M-xapropos> is equivalent to B<\Exapropos\r> + +=item and + +B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a> + +=back + +The option B<< {I<right-rtext>} >> will be right-justified. In the +absence of a specified action, this text will be used as the I<action> +as well. + +=over 4 + +=item For example, + +B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F> + +=back + +The left label I<is> necessary, since it's used for matching, but +implicitly hiding the left label (by using same name for both left and +right labels), or explicitly hiding the left label (by preceeding it +with a dot), makes it possible to have right-justified text only. + +=over 4 + +=item For example, + +B</File/{Open}{Open} Open-File-Action> + +=item or hiding it + +B</File/{.anylabel}{Open} Open-File-Action> + +=back + +X<menuBarRemove> + +=head2 Removing menus + +=over 4 + +=item B<< -/*+ >> + +remove all menus from the menuBar, the same as B<[clear]> + +=item B<< -+I</path>menu+ >> + +remove menu + +=item B<< -+I</path>{item}+ >> + +remove item + +=item B<< -+I</path>{-} >> + +remove separator) + +=item B<-/path/menu/*> + +remove all items, separators and submenus from menu + +=back + +X<menuBarArrows> + +=head2 Quick Arrows + +The menus also provide a hook for I<quick arrows> to provide easier +user access. If nothing has been explicitly set, the default is to +emulate the curror keys. The syntax permits each arrow to be altered +individually or all four at once without re-entering their common +beginning/end text. For example, to explicitly associate cursor actions +with the arrows, any of the following forms could be used: + +=over 4 + +=item B<< <r>+I<Right> >> + +=item B<< <l>+I<Left> >> + +=item B<< <u>+I<Up> >> + +=item B<< <d>+I<Down> >> + +Define actions for the respective arrow buttons + +=item B<< <b>+I<Begin> >> + +=item B<< <e>+I<End> >> + +Define common beginning/end parts for I<quick arrows> which used in +conjunction with the above <r> <l> <u> <d> constructs + +=back + +=over 4 + +=item For example, define arrows individually, + + <u>\E[A + + <d>\E[B + + <r>\E[C + + <l>\E[D + +=item or all at once + + <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D + +=item or more compactly (factoring out common parts) + + <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D + +=back + +X<menuBarSummary> + +=head2 Command Summary + +A short summary of the most I<common> commands: + +=over 4 + +=item [menu:name] + +use an existing named menuBar or start a new one + +=item [menu] + +use the current menuBar + +=item [title:string] + +set menuBar title + +=item [done] + +set menu access to readonly and, if reading from a file, signal EOF + +=item [done:name] + +if reading from a file using [read:file;name] signal EOF + +=item [rm:name] + +remove named menuBar(s) + +=item [rm] [rm:] + +remove current menuBar + +=item [rm*] [rm:*] + +remove all menuBar(s) + +=item [swap] + +swap top two menuBars + +=item [prev] + +access the previous menuBar + +=item [next] + +access the next menuBar + +=item [show] + +map menuBar + +=item [hide] + +unmap menuBar + +=item [pixmap;file] + +=item [pixmap;file;scaling] + +set a background pixmap + +=item [read:file] + +=item [read:file;name] + +read in a menu from a file + +=item [dump] + +dump out all menuBars to /tmp/rxvt-PID + +=item / + +access menuBar top level + +=item ./ + +=item ../ + +=item ../../ + +access current or parent menu level + +=item /path/menu + +add/access menu + +=item /path/{-} + +add separator + +=item /path/{item}{rtext} action + +add/alter menu item + +=item -/* + +remove all menus from the menuBar + +=item -/path/menu + +remove menu items, separators and submenus from menu + +=item -/path/menu + +remove menu + +=item -/path/{item} + +remove item + +=item -/path/{-} + +remove separator + +=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End + +menu quick arrows + +=back +X<XPM> + +=head1 XPM + +For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value +of B<< C<Pt> >> can be the name of the background pixmap followed by a +sequence of scaling/positioning commands separated by semi-colons. The +scaling/positioning commands are as follows: + +=over 4 + +=item query scale/position + +B<?> + +=item change scale and position + +B<WxH+X+Y> + +B<WxH+X> (== B<WxH+X+X>) + +B<WxH> (same as B<WxH+50+50>) + +B<W+X+Y> (same as B<WxW+X+Y>) + +B<W+X> (same as B<WxW+X+X>) + +B<W> (same as B<WxW+50+50>) + +=item change position (absolute) + +B<=+X+Y> + +B<=+X> (same as B<=+X+Y>) + +=item change position (relative) + +B<+X+Y> + +B<+X> (same as B<+X+Y>) + +=item rescale (relative) + +B<Wx0> -> B<W *= (W/100)> + +B<0xH> -> B<H *= (H/100)> + +=back + +For example: + +=over 4 + +=item B<\E]20;funky\a> + +load B<funky.xpm> as a tiled image + +=item B<\E]20;mona;100\a> + +load B<mona.xpm> with a scaling of 100% + +=item B<\E]20;;200;?\a> + +rescale the current pixmap to 200% and display the image geometry in +the title + +=back +X<Mouse> + +=head1 Mouse Reporting + +=over 4 + +=item B<< C<< ESC [ M <b> <x> <y> >> >> + +report mouse position + +=back + +The lower 2 bits of B<< C<< <b> >> >> indicate the button: + +=over 4 + +=item Button = B<< C<< (<b> - SPACE) & 3 >> >> + +=begin table + + 0 Button1 pressed + 1 Button2 pressed + 2 Button3 pressed + 3 button released (X11 mouse report) + +=end table + +=back + +The upper bits of B<< C<< <b> >> >> indicate the modifiers when the +button was pressed and are added together (X11 mouse report only): + +=over 4 + +=item State = B<< C<< (<b> - SPACE) & 60 >> >> + +=begin table + + 4 Shift + 8 Meta + 16 Control + 32 Double Click I<(Rxvt extension)> + +=end table + +Col = B<< C<< <x> - SPACE >> >> + +Row = B<< C<< <y> - SPACE >> >> + +=back +X<KeyCodes> + +=head1 ISO 14755 support + +Partial ISO 14755-support is implemented. that means that pressing + +section 5.1: Control and Shift together enters unicode input +mode. Entering hex digits composes a Unicode character, pressing space or +releasing the modifiers commits the keycode and every other key cancels +the current input character. + +section 5.2: Pressing and immediately releasing Control and Shift together +enters keycap entry mode for the next key: pressing a function key (tab, +return etc..) will enter the unicode character corresponding to the given +key. + +=head1 Key Codes + +Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> + +For the keypad, use B<Shift> to temporarily override Application-Keypad +setting use B<Num_Lock> to toggle Application-Keypad setting if +B<Num_Lock> is off, toggle Application-Keypad setting. Also note that +values of B<Home>, B<End>, B<Delete> may have been compiled differently on +your system. + +=begin table + + B<Normal> B<Shift> B<Control> B<Ctrl+Shift> + Tab ^I ESC [ Z ^I ESC [ Z + BackSpace ^H ^? ^? ^? + Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @ + Insert ESC [ 2 ~ I<paste> ESC [ 2 ^ ESC [ 2 @ + Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @ + Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @ + Prior ESC [ 5 ~ I<scroll-up> ESC [ 5 ^ ESC [ 5 @ + Next ESC [ 6 ~ I<scroll-down> ESC [ 6 ^ ESC [ 6 @ + Home ESC [ 7 ~ ESC [ 7 $ ESC [ 7 ^ ESC [ 7 @ + End ESC [ 8 ~ ESC [ 8 $ ESC [ 8 ^ ESC [ 8 @ + Delete ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @ + F1 ESC [ 11 ~ ESC [ 23 ~ ESC [ 11 ^ ESC [ 23 ^ + F2 ESC [ 12 ~ ESC [ 24 ~ ESC [ 12 ^ ESC [ 24 ^ + F3 ESC [ 13 ~ ESC [ 25 ~ ESC [ 13 ^ ESC [ 25 ^ + F4 ESC [ 14 ~ ESC [ 26 ~ ESC [ 14 ^ ESC [ 26 ^ + F5 ESC [ 15 ~ ESC [ 28 ~ ESC [ 15 ^ ESC [ 28 ^ + F6 ESC [ 17 ~ ESC [ 29 ~ ESC [ 17 ^ ESC [ 29 ^ + F7 ESC [ 18 ~ ESC [ 31 ~ ESC [ 18 ^ ESC [ 31 ^ + F8 ESC [ 19 ~ ESC [ 32 ~ ESC [ 19 ^ ESC [ 32 ^ + F9 ESC [ 20 ~ ESC [ 33 ~ ESC [ 20 ^ ESC [ 33 ^ + F10 ESC [ 21 ~ ESC [ 34 ~ ESC [ 21 ^ ESC [ 34 ^ + F11 ESC [ 23 ~ ESC [ 23 $ ESC [ 23 ^ ESC [ 23 @ + F12 ESC [ 24 ~ ESC [ 24 $ ESC [ 24 ^ ESC [ 24 @ + F13 ESC [ 25 ~ ESC [ 25 $ ESC [ 25 ^ ESC [ 25 @ + F14 ESC [ 26 ~ ESC [ 26 $ ESC [ 26 ^ ESC [ 26 @ + F15 (Help) ESC [ 28 ~ ESC [ 28 $ ESC [ 28 ^ ESC [ 28 @ + F16 (Menu) ESC [ 29 ~ ESC [ 29 $ ESC [ 29 ^ ESC [ 29 @ + F17 ESC [ 31 ~ ESC [ 31 $ ESC [ 31 ^ ESC [ 31 @ + F18 ESC [ 32 ~ ESC [ 32 $ ESC [ 32 ^ ESC [ 32 @ + F19 ESC [ 33 ~ ESC [ 33 $ ESC [ 33 ^ ESC [ 33 @ + F20 ESC [ 34 ~ ESC [ 34 $ ESC [ 34 ^ ESC [ 34 @ + B<Application> + Up ESC [ A ESC [ a ESC O a ESC O A + Down ESC [ B ESC [ b ESC O b ESC O B + Right ESC [ C ESC [ c ESC O c ESC O C + Left ESC [ D ESC [ d ESC O d ESC O D + KP_Enter ^M ESC O M + KP_F1 ESC O P ESC O P + KP_F2 ESC O Q ESC O Q + KP_F3 ESC O R ESC O R + KP_F4 ESC O S ESC O S + XK_KP_Multiply * ESC O j + XK_KP_Add + ESC O k + XK_KP_Separator , ESC O l + XK_KP_Subtract - ESC O m + XK_KP_Decimal . ESC O n + XK_KP_Divide / ESC O o + XK_KP_0 0 ESC O p + XK_KP_1 1 ESC O q + XK_KP_2 2 ESC O r + XK_KP_3 3 ESC O s + XK_KP_4 4 ESC O t + XK_KP_5 5 ESC O u + XK_KP_6 6 ESC O v + XK_KP_7 7 ESC O w + XK_KP_8 8 ESC O x + XK_KP_9 9 ESC O y + +=end table + diff --git a/doc/rxvtRef-toc.html b/doc/rxvtRef-toc.html deleted file mode 100644 index d3260902ad6ea97e947b62c18ab85e2b84520699..0000000000000000000000000000000000000000 --- a/doc/rxvtRef-toc.html +++ /dev/null @@ -1,32 +0,0 @@ -<HTML> -<HEAD> -<TITLE>rxvtRef TOC</TITLE> -</HEAD> -<BASE TARGET="main"> -<BODY BGCOLOR="#FFFFFF"> -<CENTER> -<HR> -<STRONG> -<A HREF="rxvt.html">Man Page</A></B> -<HR> -<A HREF="rxvtRef.html#Top">Reference</A> -</STRONG> -<A HREF="rxvtRef.html#Definitions">Definitions</A><BR> -<A HREF="rxvtRef.html#Values">Values</A><BR> -<A HREF="rxvtRef.html#Sequences">Escape</A><BR> -<A HREF="rxvtRef.html#CSI">CSI</A><BR> -<A HREF="rxvtRef.html#PrivateModes">DEC</A><BR> -<A HREF="rxvtRef.html#XTerm">XTerm</A><BR> -<A HREF="rxvtRef.html#menuBar">menuBar</A><BR> -<A HREF="rxvtRef.html#XPM">XPM</A><BR> -<A HREF="rxvtRef.html#Mouse">Mouse</A><BR> -<A HREF="rxvtRef.html#KeyCodes">KeyCodes</A><BR> -<HR> -<STRONG> -<A HREF="http://www.rxvt.org/">Rxvt Home</A><BR> -<A HREF="http://www.rxvt.org/screenshots.html">Screenshots</A> -</STRONG> -<HR> -</CENTER> -</BODY> -</HTML> diff --git a/doc/yodl/masonyodl.yo b/doc/yodl/masonyodl.yo deleted file mode 100644 index 6a5291cd1534c229960a09042bb40974377838f1..0000000000000000000000000000000000000000 --- a/doc/yodl/masonyodl.yo +++ /dev/null @@ -1,125 +0,0 @@ -COMMENT(-- $Id: masonyodl.yo,v 1.2 2003/11/24 17:31:27 pcg Exp $ --) -COMMENT(----------------------------------------------------------------------- --- We want more functionality and some better layout --- proto changes: --- starttable(nColumns)(Alignment)(borderwidth) -------------------------------------------------------------------------------) -NEWCOUNTER(RRindentlevel) -NEWCOUNTER(RRnl) -SETCOUNTER(RRindentlevel)(0) -\ -DEFINEMACRO(nltxt)(0)(\ - IFZERO(RRnl)()( ADDTOCOUNTER(RRnl)(-1)nltxt())) -\ -UNDEFINEMACRO(XXnl) -DEFINEMACRO(XXnl)(0)(\ - NOTRANS( -)\ - whentxt(SETCOUNTER(RRnl)(RRindentlevel)nltxt())) -\ -DEFINEMACRO(P)(0)(\ - SETCOUNTER(RRnl)(0)\ - whenhtml(SETCOUNTER(RRnl)(1)htmlcommand(<p>))\ - IFZERO(RRnl)(nl())()) -\ -UNDEFINEMACRO(starttable) -DEFINEMACRO(starttable)(3)(\ - SETCOUNTER(XXtablewidth)(ARG1)\ - whenhtml(IFZERO(ARG3)(htmlcommand(<table>))\ - (htmlcommand(<table border=ARG3>))XXnl())\ - whenlatex(latexcommand(\begin{tabular}{)ARG2+latexcommand(}))\ - whenman(roffcmd(.TS)()()())\ - whenman(IFZERO(ARG3)(roffcmd(tab(`);)()()())\ - (roffcmd(allbox,tab(`);)()()()))\ - whenman(ARG2 NOTRANS(. -))\ - whenms(roffcmd(.TS)()()())\ - whenms(IFZERO(ARG3)(roffcmd(tab(`);)()()())\ - (roffcmd(allbox,tab(`);)()()()))\ - whenms(ARG2+mscommand(.))\ - SETCOUNTER(XXtablewidth)(ARG1)\ - SETCOUNTER(XXparcounter)(0)) -COMMENT( For HTML, we'll need <table>, for - LaTeX we'll need \begin{tabular}{alignment}. Also, we don't want - paragraph delimiters.) -\ -UNDEFINEMACRO(cell) -DEFINEMACRO(cell)(1)(\ - ADDTOCOUNTER(XXtableline)(1)\ - whenhtml(htmlcommand(<td>) ARG1 \ - IFZERO(XXcellcounter)\ - (htmlcommand(<br>))\ - ()\ - htmlcommand(</td>) XXnl())\ - whenlatex(ARG1 \ - IFZERO(XXcellcounter)\ - ()(latexcommand( & )))\ - whentxt( ARG1 )\ - whenms( ARG1 )\ - IFZERO(XXcellcounter)\ - ()\ - (mscommand(`\))\ - whenman( ARG1 )\ - IFZERO(XXcellcounter)\ - ()\ - (mancommand(`\))\ - ADDTOCOUNTER(XXcellcounter)(-1)) -COMMENT(For HTML we need: -<td> text </td>, so that's fairly easy. If we're already at the last -cell, we need <td> text <br></td>. -For LaTeX: we need text followed by &, unless - we're already at the last cell 'cuz in that case we need only text. - Also we need to decrement the cell counter..) -\ -UNDEFINEMACRO(cells) -DEFINEMACRO(cells)(2)(\ - ADDTOCOUNTER(XXtableline)(ARG1)\ - ADDTOCOUNTER(XXcellcounter)(-ARG1)\ - ADDTOCOUNTER(XXcellcounter)(1)\ - whenhtml(htmlcommand(<td colspan=ARG1 align=center>) ARG2 \ - IFZERO(XXcellcounter)\ - (htmlcommand(<br>))\ - ()\ - htmlcommand(</td>) XXnl())\ - whenlatex(\ - latexcommand(\multicolumn{)ARG1+latexcommand(}{c}{)ARG2+latexcommand(})\ - IFZERO(XXcellcounter)\ - ()(latexcommand( & )))\ - whentxt( ARG1 )\ - whenms( ARG1 )\ - IFZERO(XXcellcounter)\ - ()\ - (mscommand(`\))\ - whenman( ARG1 )\ - IFZERO(XXcellcounter)\ - ()\ - (mancommand(`\))\ - ADDTOCOUNTER(XXcellcounter)(-1)) -\ -DEFINEMACRO(indent)(1)(\ - whenhtml(htmlcommand(<ul>)ARG1+htmlcommand(</ul>))\ - whentxt(ADDTOCOUNTER(RRindentlevel)(4)ARG1+ADDTOCOUNTER(RRindentlevel)(-4))\ - whenman(roffcmd(.RS)()()()roffcmd(.HP)()()()ARG1+roffcmd(.RE)()()())\ - whenms()) -\ -DEFINEMACRO(startdl)(0)(\ - whenhtml(htmlcommand(<dl>))\ - whentxt(ADDTOCOUNTER(RRindentlevel)(4))\ - whenman(startdit())) -\ -DEFINEMACRO(enddl)(0)(\ - whenhtml(htmlcommand(</dl>))\ - whentxt(ADDTOCOUNTER(RRindentlevel)(-4))\ - whenman(enddit())) -\ -DEFINEMACRO(dl)(2)(\ - whenhtml(htmlcommand(<dt>)ARG1+htmlcommand(</dt><dd>)\ - ARG2+htmlcommand(</dd>))\ - whentxt(ADDTOCOUNTER(RRindentlevel)(2)dit(ARG1)\ - ADDTOCOUNTER(RRindentlevel)(2)nl()\ - ARG2+ADDTOCOUNTER(RRindentlevel)(-4))\ - whenman(dit(ARG1)ARG2)) -\ -DEFINEMACRO(manpageauthors)(0)(\ - manpagesection(AUTHORS)\ - DEFINESYMBOL(XXmanpageAuthor)) diff --git a/doc/yodl/rxvt-colours.yo b/doc/yodl/rxvt-colours.yo deleted file mode 100644 index 5fad6c0c8f6973f3968f3d9f32f082a0ad0eab72..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvt-colours.yo +++ /dev/null @@ -1,46 +0,0 @@ -COMMENT(-- $Id: rxvt-colours.yo,v 1.4 2004/03/14 21:59:58 pcg Exp $ --) -COMMENT(----------------------------------------------------------------------) -manpagesection(COLORS AND GRAPHICS) - -In addition to the default foreground and background colours, bf(RXVTNAME()) -can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink -versions of the same). -Here is a list of the colours with their bf(rgb.txt) names. - -starttable(3)(l l l)(0)\ - row(cell(bf(color0))cell((black))cell(= Black))\ - row(cell(bf(color1))cell((red))cell(= Red3))\ - row(cell(bf(color2))cell((green))cell(= Green3))\ - row(cell(bf(color3))cell((yellow))cell(= Yellow3))\ - row(cell(bf(color4))cell((blue))cell(= Blue3))\ - row(cell(bf(color5))cell((magenta))cell(= Magenta3))\ - row(cell(bf(color6))cell((cyan))cell(= Cyan3))\ - row(cell(bf(color7))cell((white))cell(= AntiqueWhite))\ - row(cell(bf(color8))cell((bright black))cell(= Grey25))\ - row(cell(bf(color9))cell((bright red))cell(= Red))\ - row(cell(bf(color10))cell((bright green))cell(= Green))\ - row(cell(bf(color11))cell((bright yellow))cell(= Yellow))\ - row(cell(bf(color12))cell((bright blue))cell(= Blue))\ - row(cell(bf(color13))cell((bright magenta))cell(= Magenta))\ - row(cell(bf(color14))cell((bright cyan))cell(= Cyan))\ - row(cell(bf(color15))cell((bright white))cell(= White))\ - row(cell(bf(foreground))cell()cell(= Black))\ - row(cell(bf(background))cell()cell(= White))\ -endtable() - -It is also possible to specify the colour values of bf(foreground), -bf(background), bf(cursorColor), bf(cursorColor2), bf(colorBD), bf(colorUL) -as a number 0-15, as a convenient shorthand to reference the colour name of -color0-color15. - -Note that bf(-rv) (bf("reverseVideo: True")) simulates reverse video by -always swapping the foreground/background colours. This is in contrast to -em(xterm)(1) where the colours are only swapped if they have not otherwise been -specified. -For example, - -startdit() - dit(bf(rxvt -fg Black -bg White -rv)) - would yield White on Black, while on em(xterm)(1) it would yield - Black on White. -enddit() diff --git a/doc/yodl/rxvt-environment.yo b/doc/yodl/rxvt-environment.yo deleted file mode 100644 index c8a3850be27261955fa8ff7c82269fc319bd6b53..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvt-environment.yo +++ /dev/null @@ -1,9 +0,0 @@ -COMMENT(-- $Id: rxvt-environment.yo,v 1.3 2004/03/14 21:59:58 pcg Exp $ --) -COMMENT(----------------------------------------------------------------------) -manpagesection(ENVIRONMENT) - -bf(RXVTNAME()) sets the environment variables bf(TERM), bf(COLORTERM) and -bf(COLORFGBG). The environment variable bf(WINDOWID) is set to the X window -id number of the bf(RXVTNAME()) window and it also uses and sets the environment -variable bf(DISPLAY) to specify which display terminal to use. bf(RXVTNAME()) uses -the environment variables bf(RXVTPATH) and bf(PATH) to find XPM files. diff --git a/doc/yodl/rxvt-files.yo b/doc/yodl/rxvt-files.yo deleted file mode 100644 index ec09757c3025d5f92106e23f86125426372e6aaf..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvt-files.yo +++ /dev/null @@ -1,8 +0,0 @@ -COMMENT(-- $Id: rxvt-files.yo,v 1.2 2003/11/24 17:31:27 pcg Exp $ --) -COMMENT(----------------------------------------------------------------------) -manpagesection(FILES) - -startdit() - dit(bf(/etc/utmp)) System file for login records. - dit(bf(/usr/lib/X11/rgb.txt)) Color names. -enddit() diff --git a/doc/yodl/rxvt-fonts.yo b/doc/yodl/rxvt-fonts.yo deleted file mode 100644 index ae7b016e4de30ba0f8f46a2b40d2d6e783b07119..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvt-fonts.yo +++ /dev/null @@ -1,9 +0,0 @@ -COMMENT(-- $Id: rxvt-fonts.yo,v 1.2 2003/11/24 17:31:27 pcg Exp $ --) -COMMENT(----------------------------------------------------------------------) -manpagesection(CHANGING FONTS) - -You can change fonts on-the-fly, which is to say cycle through the default -font and others of various sizes, by using bf(Shift-KP_Add) and -bf(Shift-KP_Subtract). Or, alternatively (if enabled) with -bf(HOTKEY()-BIGFONT()) and bf(HOTKEY()-SMALLFONT()), where the actual key -can be selected using resources bf(smallfont_key)/bf(bigfont_key). diff --git a/doc/yodl/rxvt-login.yo b/doc/yodl/rxvt-login.yo deleted file mode 100644 index a65cf5f8299de8c2ba1d9c1863f885a8a004d7cb..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvt-login.yo +++ /dev/null @@ -1,7 +0,0 @@ -COMMENT(-- $Id: rxvt-login.yo,v 1.3 2004/03/14 21:59:58 pcg Exp $ --) -COMMENT(----------------------------------------------------------------------) -manpagesection(LOGIN STAMP) - -bf(RXVTNAME()) tries to write an entry into the em(utmp)(5) file so that it can be -seen via the em(who(1)) command, and can accept messages. To allow this -feature, bf(RXVTNAME()) must be installed setuid root on some systems. diff --git a/doc/yodl/rxvt-mousereporting.yo b/doc/yodl/rxvt-mousereporting.yo deleted file mode 100644 index 15ecbb4ddd11202e5592765236d2b50159ec18a5..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvt-mousereporting.yo +++ /dev/null @@ -1,14 +0,0 @@ -COMMENT(-- $Id: rxvt-mousereporting.yo,v 1.2 2003/11/24 17:31:27 pcg Exp $ --) -COMMENT(----------------------------------------------------------------------) -manpagesection(MOUSE REPORTING) - -To temporarily override mouse reporting, for either the scrollbar or the -normal text selection/insertion, hold either the Shift or the Meta (Alt) key -while performing the desired mouse action. - -If mouse reporting mode is active, the normal scrollbar actions are disabled --- on the assumption that we are using a fullscreen application. -Instead, pressing Button1 and Button3 sends -bf(ESC[6~) (Next) and bf(ESC[5~) (Prior), respectively. -Similarly, clicking on the up and down arrows sends bf(ESC[A) (Up) and -bf(ESC[B) (Down), respectively. diff --git a/doc/yodl/rxvt-options.yo b/doc/yodl/rxvt-options.yo deleted file mode 100644 index 885836135261b19793a90858cd64ffa33f0b2d9a..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvt-options.yo +++ /dev/null @@ -1,205 +0,0 @@ -COMMENT(-- $Id: rxvt-options.yo,v 1.19 2004/08/08 16:43:55 root Exp $ --) -COMMENT(----------------------------------------------------------------------) -manpageoptions() - -The bf(RXVTNAME()) options (mostly a subset of em(xterm)'s) are listed below. -In keeping with the smaller-is-better philosophy, options may be eliminated -or default values chosen at compile-time, so options and defaults listed -may not accurately reflect the version installed on your system. -`rxvt -h' gives a list of major compile-time options on the em(Options) line. -Option descriptions may be prefixed with which compile option each is -dependent upon. e.g. `Compile em(XIM):' requires em(XIM) on the em(Options) -line. Note: `rxvt -help' gives a list of all command-line options compiled -into your version. - -Note that bf(RXVTNAME()) permits the resource name to be used as a long-option -(--/++ option) so the potential command-line options are far greater than -those listed. -For example: `rxvt --loginShell --color1 Orange'. - -The following options are available: - -startdit() - dit(bf(-help), bf(--help)) - Print out a message describing available options. - dit(bf(-display) em(displayname)) - Attempt to open a window on the named X display (bf(-d) still - respected). In the absence of this option, the display specified - by the bf(DISPLAY) environment variable is used. - dit(bf(-geometry) em(geom)) - Window geometry (bf(-g) still respected); - resource bf(geometry). - dit(bf(-rv)|bf(+rv)) - Turn on/off simulated reverse video; - resource bf(reverseVideo). - dit(bf(-j)|bf(+j)) - Turn on/off jump scrolling; - resource bf(jumpScroll). - dit(bf(-ip)|bf(+ip)) - Turn on/off inheriting parent window's pixmap. Alternative form - is bf(-tr); - resource bf(inheritPixmap). - dit(bf(-fade) em(number)) - Fade the text by the given percentage when focus is lost. - dit(bf(-tint) em(colour)) - Tint the transparent background pixmap with the given colour when - transparency is enabled with bf(-tr) or bf(-ip). See also - the bf(-sh) option that can be used to brighten or darken - the image in addition to tinting it. - dit(bf(-sh)) em(number) - Darken (0 .. 100) or lighten (-1 .. -100) the transparent background - image in addition to tinting it (i.e. bf(-tint) must be specified, too). - dit(bf(-bg) em(colour)) - Window background colour; - resource bf(background). - dit(bf(-fg) em(colour)) - Window foreground colour; - resource bf(foreground). - dit(bf(-pixmap) em(file[;geom])) - Compile em(XPM): Specify XPM file for the background and also - optionally specify its scaling with a geometry string. Note you - may need to add quotes to avoid special shell interpretation of - the `;' in the command-line; - resource bf(backgroundPixmap). - dit(bf(-cr) em(colour)) - The cursor colour; - resource bf(cursorColor). - dit(bf(-pr) em(colour)) - The mouse pointer foreground colour; - resource bf(pointerColor). - dit(bf(-pr2) em(colour)) - The mouse pointer background colour; - resource bf(pointerColor2). - dit(bf(-bd) em(colour)) - The colour of the border between the xterm scrollbar and the text; - resource bf(borderColor). - dit(bf(-fn) em(fontname)) - Select the fonts to be used. - This is a comma seperated list of font names that are used in turn when - trying to display Unicode characters. - The first font defines the cell size for characters; other fonts might - be smaller, but not larger. - A reasonable default font list is always appended to it. - resource bf(font). - dit(bf(-rb)|bf(+rb)) - Enable "real bold" support. - When this option is on, bold text will be displayed using the first - available bold font in the font list. - Bold fonts should thus be specified in the font list after their - corresponding regular fonts. - If no bold font can be found, a regular font will be used. - resource bf(realBold). - dit(bf(-name) em(name)) - Specify the application name under which resources - are to be obtained, rather than the default executable file name. - Name should not contain `.' or `*' characters. - Also sets the icon and title name. - dit(bf(-ls)|bf(+ls)) - Start as a login-shell/sub-shell; - resource bf(loginShell). - dit(bf(-ut)|bf(+ut)) - Compile em(utmp): Inhibit/enable writing a utmp entry; - resource bf(utmpInhibit). - dit(bf(-vb)|bf(+vb)) - Turn on/off visual bell on receipt of a bell character; - resource bf(visualBell). - dit(bf(-sb)|bf(+sb)) - Turn on/off scrollbar; - resource bf(scrollBar). - dit(bf(-si)|bf(+si)) - Turn on/off scroll-to-bottom on TTY output inhibit; - resource bf(scrollTtyOutput) has opposite effect. - dit(bf(-sk)|bf(+sk)) - Turn on/off scroll-to-bottom on keypress; - resource bf(scrollTtyKeypress). - dit(bf(-sw)|bf(+sw)) - Turn on/off scrolling with the scrollback buffer as new - lines appear. This only takes effect if bf(-si) is also given; - resource bf(scrollWithBuffer). - dit(bf(-sr)|bf(+sr)) - Put scrollbar on right/left; - resource bf(scrollBar_right). - dit(bf(-st)|bf(+st)) - Display normal (non XTerm/NeXT) scrollbar without/with a trough; - resource bf(scrollBar_floating). - dit(bf(-bc)|bf(+bc)) - Blink the cursor; resource bf(cursorBlink). - dit(bf(-iconic)) - Start iconified, if the window manager supports that option. - Alternative form is bf(-ic). - dit(bf(-sl) em(number)) - Save em(number) lines in the scrollback buffer. See resource entry - for limits; - resource bf(saveLines). - dit(bf(-b) em(number)) - Compile em(frills): Internal border of em(number) pixels. See - resource entry for limits; - resource bf(internalBorder). - dit(bf(-w) em(number)) - Compile em(frills): External border of em(number) pixels. - Also, bf(-bw) and bf(-borderwidth). See resource entry for limits; - resource bf(externalBorder). - dit(bf(-bl)) - Compile em(frills): Set MWM hints to request a borderless window, - i.e. if honoured by the WM, the rxvt window will not have window - decorations; resource bf(borderLess). - dit(bf(-lsp) em(number)) - Compile em(linespace): Lines (pixel height) to insert between each - row of the display; - resource bf(linespace). - dit(bf(-tn) em(termname)) - This option specifies the name of the terminal type to be set in the - bf(TERM) environment variable. This terminal type must exist in the - em(termcap(5)) database and should have em(li#) and em(co#) entries; - resource bf(termName). - dit(bf(-e) em(command [arguments])) - Run the command with its command-line arguments in the bf(RXVTNAME()) - window; also sets the window title and icon name to be the basename - of the program being executed if neither em(-title) (em(-T)) nor - em(-n) are given on the command line. If this option is used, it - must be the last on the command-line. If there is no bf(-e) option - then the default is to run the program specified by the bf(SHELL) - environment variable or, failing that, em(sh(1)). - dit(bf(-title) em(text)) - Window title (bf(-T) still respected); the default title is the - basename of the program specified after the bf(-e) option, if - any, otherwise the application name; - resource bf(title). - dit(bf(-n) em(text)) - Icon name; the default name is the basename of the program specified - after the bf(-e) option, if any, otherwise the application name; - resource bf(iconName). - dit(bf(-C)) - Capture system console messages. - dit(bf(-pt) em(style)) - Compile em(XIM): input style for input method; - bf(OverTheSpot), bf(OffTheSpot), bf(Root); - resource bf(preeditType). - dit(bf(-im) em(text)) - Compile em(XIM): input method name. - resource bf(inputMethod). - dit(bf(-imlocale) em(string)) - The locale to use for opening the IM. You can use an LC_CTYPE - of e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP - for the input extension to be able to input japanese characters - while staying in another locale. - dit(bf(-insecure)) - Enable "insecure" mode, which currently enables most of the escape - sequences that echo strings. See the resource bf(insecure) for - more info. - dit(bf(-mod) em(modifier)) - Override detection of Meta modifier with specified key: - bf(alt), bf(meta), bf(hyper), bf(super), bf(mod1), bf(mod2), bf(mod3), - bf(mod4), bf(mod5); - resource em(modifier). - dit(bf(-ssc)|bf(+ssc)) - Turn on/off secondary screen (default enabled); - resource bf(secondaryScreen). - dit(bf(-ssr)|bf(+ssr)) - Turn on/off secondary screen scroll (default enabled); - resource bf(secondaryScroll). - dit(bf(-xrm) em(resourcestring)) - No effect on rxvt. Simply passes through an argument to be made - available in the instance's argument list. Appears in em(WM_COMMAND) - in some window managers. -enddit() diff --git a/doc/yodl/rxvt-resources.yo b/doc/yodl/rxvt-resources.yo deleted file mode 100644 index 085c1521678f6165279361b150e71317597bb34c..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvt-resources.yo +++ /dev/null @@ -1,322 +0,0 @@ -COMMENT(-- $Id: rxvt-resources.yo,v 1.19 2004/08/08 16:43:55 root Exp $ --) -COMMENT(----------------------------------------------------------------------) -manpagesection(RESOURCES (available also as long-options)) - -Note: `RXVTNAME() --help' gives a list of all resources (long options) compiled -into your version. - -There are two different methods that RXVTNAME() can use to get the -Xresource data: using the X libraries (Xrm*-functions) or internal Xresources -reader (bf(~/.Xdefaults)). For the first method (ie. bf(RXVTNAME() -h) lists -bf(XGetDefaults)), you can set and change the resources using X11 -tools like bf(xset). Many distribution do also load settings from the -bf(~/.Xresources) file when X starts. - -If compiled with internal Xresources support (i.e. bf(RXVTNAME() --h) lists bf(.Xdefaults)) then bf(RXVTNAME()) accepts application -defaults set in XAPPLOADDIR/URxvt (compile-time defined: usually -bf(/usr/lib/X11/app-defaults/URxvt)) and resources set in -bf(~/.Xdefaults), or bf(~/.Xresources) if bf(~/.Xdefaults) does not exist. -Note that when reading X resources, bf(RXVTNAME()) recognizes two class -names: bf(XTerm) and bf(URxvt). The class name bf(Rxvt) allows resources -common to both bf(RXVTNAME()) and the original em(rxvt) to be easily configured, -while the class name bf(URxvt) allows resources unique to bf(RXVTNAME()), -notably colours and key-handling, to be shared between different -bf(RXVTNAME()) configurations. If no resources are specified, suitable -defaults will be used. Command-line arguments can be used to override -resource settings. The following resources are allowed: - -startdit() - dit(bf(geometry:) em(geom)) - Create the window with the specified X window geometry [default - 80x24]; - option bf(-geometry). - dit(bf(background:) em(colour)) - Use the specified colour as the window's background colour [default - White]; - option bf(-bg). - dit(bf(foreground:) em(colour)) - Use the specified colour as the window's foreground colour [default - Black]; - option bf(-fg). - dit(bf(color)em(n)bf(:) em(colour)) - Use the specified colour for the colour value em(n), where 0-7 - corresponds to low-intensity (normal) colours and 8-15 corresponds to - high-intensity (bold = bright foreground, blink = bright - background) colours. The canonical names are as follows: - 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, - but the actual colour names used are listed in the - bf(COLORS AND GRAPHICS) section. - dit(bf(colorBD:) em(colour)) - Use the specified colour to display bold characters when the - foreground colour is the default. - This option will be ignored if bf(realBold) is enabled. - dit(bf(colorUL:) em(colour)) - Use the specified colour to display underlined characters when the - foreground colour is the default. - dit(bf(colorRV:) em(colour)) - Use the specified colour as the background for reverse video - characters. - dit(bf(cursorColor:) em(colour)) - Use the specified colour for the cursor. The default is to use the - foreground colour; - option bf(-cr). - dit(bf(cursorColor2:) em(colour)) - Use the specified colour for the colour of the cursor text. For this - to take effect, bf(cursorColor) must also be specified. The default - is to use the background colour. - dit(bf(reverseVideo:) em(boolean)) - bf(True): simulate reverse video by foreground and background colours; - option bf(-rv). - bf(False): regular screen colours [default]; - option bf(+rv). - See note in bf(COLORS AND GRAPHICS) section. - dit(bf(jumpScroll:) em(boolean)) - bf(True): specify that jump scrolling should be used. When scrolling - quickly, fewer screen updates are performed [default]; - option bf(-j). - bf(False): specify that smooth scrolling should be used; - option bf(+j). - dit(bf(inheritPixmap:) em(boolean)) - bf(True): make the background inherit the parent windows' pixmap, - giving artificial transparency. - bf(False): do not inherit the parent windows' pixmap. - dit(bf(fading:) em(number)) - Fade the text by the given percentage when focus is lost. - dit(bf(tintColor:) em(colour)) - Tint the transparent background pixmap with the given colour. - dit(bf(shading:) em(number)) - Darken (0 .. 100) or lighten (-1 .. -100) the transparent background - image in addition to tinting it. - dit(bf(fading:) em(number)) - Scale the tint colour by the given percentage. - dit(bf(scrollColor:) em(colour)) - Use the specified colour for the scrollbar [default #B2B2B2]. - dit(bf(troughColor:) em(colour)) - Use the specified colour for the scrollbar's trough area [default - #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. - dit(bf(backgroundPixmap:) em(file[;geom])) - Use the specified XPM file (note the `.xpm' extension is optional) - for the background and also optionally specify its scaling with a - geometry string bf(WxH+X+Y), in which bf("W" / "H") specify the - horizontal/vertical scale (percent) and bf("X" / "Y") locate the - image centre (percent). A scale of 0 displays the image with tiling. - A scale of 1 displays the image without any scaling. A scale of 2 to - 9 specifies an integer number of images in that direction. No image - will be magnified beyond 10 times its original size. The maximum - permitted scale is 1000. [default 0x0+50+50] - dit(bf(menu:) em(file[;tag])) - Read in the specified menu file (note the `.menu' extension is - optional) and also optionally specify a starting tag to find. See - the reference documentation for details on the syntax for the menuBar. - dit(bf(path:) em(path)) - Specify the colon-delimited search path for finding files (XPM and - menus), in addition to the paths specified by the bf(RXVTPATH) and - bf(PATH) environment variables. - dit(bf(font:) em(fontname)) - Select the fonts to be used. - This is a comma seperated list of font names that are used in turn when - trying to display Unicode characters. - The first font defines the cell size for characters; other fonts might - be smaller, but not larger. - A reasonable default font list is always appended to it. - option bf(-fn). - dit(bf(realBold:) em(boolean)) - bf(True): Enable "real bold" support. - When this option is on, bold text will be displayed using the first - available bold font in the font list. - Bold fonts should thus be specified in the font list after their - corresponding regular fonts. - If no bold font can be found, a regular font will be used. - option bf(-rb). - bf(False): Display bold text in a regular font, using the color - specified with bf(colorBD); - option bf(+rb). - dit(bf(selectstyle:) em(mode)) - Set mouse selection style to bf(old) which is 2.20, bf(oldword) which - is xterm style with 2.20 old word selection, or anything else which - gives xterm style selection. - dit(bf(scrollstyle:) em(mode)) - Set scrollbar style to bf(RXVTNAME()), bf(rxvt), bf(plain), bf(next) or bf(xterm) - dit(bf(title:) em(string)) - Set window title string, the default title is the command-line - specified after the bf(-e) option, if any, otherwise the application - name; - option bf(-title). - dit(bf(iconName:) em(string)) - Set the name used to label the window's icon or displayed in an icon - manager window, it also sets the window's title unless it is - explicitly set; - option bf(-n). - dit(bf(mapAlert:) em(boolean)) - bf(True): de-iconify (map) on receipt of a bell character. - bf(False): no de-iconify (map) on receipt of a bell character - [default]. - dit(bf(visualBell:) em(boolean)) - bf(True): use visual bell on receipt of a bell character; - option bf(-vb). - bf(False): no visual bell [default]; - option bf(+vb). - dit(bf(loginShell:) em(boolean)) - bf(True): start as a login shell by prepending a `-' to bf(argv[0]) - of the shell; - option bf(-ls). - bf(False): start as a normal sub-shell [default]; - option bf(+ls). - dit(bf(utmpInhibit:) em(boolean)) - bf(True): inhibit writing record into the system log file bf(utmp); - option bf(-ut). - bf(False): write record into the system log file bf(utmp) [default]; - option bf(+ut). - dit(bf(print-pipe:) em(string)) - Specify a command pipe for vt100 printer [default em(lpr(1))]. Use - bf(Print) to initiate a screen dump to the printer and bf(Ctrl-Print) - or bf(Shift-Print) to include the scrollback as well. - dit(bf(scrollBar:) em(boolean)) - bf(True): enable the scrollbar [default]; - option bf(-sb). - bf(False): disable the scrollbar; - option bf(+sb). - dit(bf(scrollBar_right:) em(boolean)) - bf(True): place the scrollbar on the right of the window; - option bf(-sr). - bf(False): place the scrollbar on the left of the window; - option bf(+sr). - dit(bf(scrollBar_floating:) em(boolean)) - bf(True): display an rxvt scrollbar without a trough; - option bf(-st). - bf(False): display an rxvt scrollbar with a trough; - option bf(+st). - dit(bf(scrollBar_align:) em(mode)) - Align the bf(top), bf(bottom) or bf(centre) [default] of - the scrollbar thumb with the pointer on middle button - press/drag. - dit(bf(scrollTtyOutput:) em(boolean)) - bf(True): scroll to bottom when tty receives output; - option(+si). - bf(False): do not scroll to bottom when tty receives output; - option(-si). - dit(bf(scrollWithBuffer:) em(boolean)) - bf(True): scroll with scrollback buffer when tty recieves - new lines (and bf(scrollTtyOutput) is False); - option(+sw). - bf(False): do not scroll with scrollback buffer when tty - recieves new lines; - option(-sw). - dit(bf(scrollTtyKeypress:) em(boolean)) - bf(True): scroll to bottom when a non-special key is pressed. - Special keys are those which are intercepted by rxvt for special - handling and are not passed onto the shell; - option(-sk). - bf(False): do not scroll to bottom when a non-special key is pressed; - option(+sk). - dit(bf(smallfont_key:) em(keysym)) - If enabled, use bf(HOTKEY()-)em(keysym) to toggle to a smaller font - [default bf(HOTKEY()-SMALLFONT())] - dit(bf(bigfont_key:) em(keysym)) - If enabled, use bf(HOTKEY()-)em(keysym) to toggle to a bigger font - [default bf(HOTKEY()-BIGFONT())] - dit(bf(saveLines:) em(number)) - Save em(number) lines in the scrollback buffer [default 64]. This - resource is limited on most machines to 65535; - option bf(-sl). - dit(bf(internalBorder:) em(number)) - Internal border of em(number) pixels. This resource is limited to 100; - option bf(-b). - dit(bf(externalBorder:) em(number)) - External border of em(number) pixels. This resource is limited to 100; - option bf(-w), bf(-bw), bf(-borderwidth). - dit(bf(borderLess:) em(boolean)) - Set MWM hints to request a borderless window, - i.e. if honoured by the WM, the rxvt window will not have window - decorations; option bf(-bl). - dit(bf(termName:) em(termname)) - Specifies the terminal type name to be set in the bf(TERM) - environment variable; - option bf(-tn). - dit(bf(linespace:) em(number)) - Specifies number of lines (pixel height) to insert between each row - of the display [default 0]; - option bf(-lsp). - dit(bf(meta8:) em(boolean)) - bf(True): handle Meta (Alt) + keypress to set the 8th bit. - bf(False): handle Meta (Alt) + keypress as an escape prefix [default]. - dit(bf(mouseWheelScrollPage:) em(boolean)) - bf(True): the mouse wheel scrolls a page full. - bf(False): the mouse wheel scrolls five lines [default]. - dit(bf(cursorBlink:) em(boolean)) - bf(True): blink the cursor. - bf(False): do not blink the cursor [default]; - option bf(-bc). - dit(bf(pointerBlank:) em(boolean)) - bf(True): blank the pointer when a key is pressed or after a set number - of seconds of inactivity. - bf(False): the pointer is always visible [default]. - dit(bf(pointerColor:) em(colour)) - Mouse pointer foreground colour. - dit(bf(pointerColor2:) em(colour)) - Mouse pointer background colour. - dit(bf(pointerBlankDelay:) em(number)) - Specifies number of seconds before blanking the pointer [default 2]. - dit(bf(backspacekey:) em(string)) - The string to send when the backspace key is pressed. If set to - bf(DEC) or unset it will send bf(Delete) (code 127) or, if shifted, - bf(Backspace) (code 8) - which can be reversed with the appropriate - DEC private mode escape sequence. - dit(bf(deletekey:) em(string)) - The string to send when the delete key (not the keypad delete key) is - pressed. If unset it will send the sequence traditionally associated - with the bf(Execute) key. - dit(bf(cutchars:) em(string)) - The characters used as delimiters for double-click word selection. - The built-in default: nl()\ - bf(BACKSLASH `"'&()*,;<=>?@[]{|}) - dit(bf(preeditType:) em(style)) - bf(OverTheSpot), bf(OffTheSpot), bf(Root); - option bf(-pt). - dit(bf(inputMethod:) em(name)) - em(name) of inputMethod to use; - option bf(-im). - dit(bf(imLocale:) em(name)) - The locale to use for opening the IM. You can use an LC_CTYPE - of e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP - for the input extension to be able to input japanese characters - while staying in another locale. - option bf(-imlocale). - dit(bf(insecure)) - Enables "insecure" mode. Rxvt-unicode offers some escape sequences - that echo arbitrary strings like the icon name or the locale. This - could be abused if somebody gets 8-bit-clean access to your - display, wether throuh a mail client displaying mail bodies - unfiltered or though write(1). Therefore, these sequences are - disabled by default. (Note that other terminals, including xterm, - have these sequences enabled by default). You can enable them - by setting this boolean resource or specifying bf(-insecure) as - an option. At the moment, this enabled display-answer, locale, - findfont, icon label and window title requests as well as dynamic - menubar dispatch. - dit(bf(modifier:) em(modifier)) - Set the key to be interpreted as the Meta key to: - bf(alt), bf(meta), bf(hyper), bf(super), bf(mod1), bf(mod2), bf(mod3), - bf(mod4), bf(mod5); - option bf(-mod). - dit(bf(answerbackString:) em(string)) - Specify the reply rxvt sends to the shell when an ENQ (control-E) - character is passed through. It may contain escape values as - described in the entry on bf(keysym) following. - dit(bf(secondaryScreen:) em(bool)) - Turn on/off secondary screen (default enabled). - dit(bf(secondaryScroll:) em(bool)) - Turn on/off secondary screen scroll (default enabled). If - the this option is enabled, scrolls on the secondary screen will - change the scrollback buffer and switching to/from the secondary screen - will instead scroll the screen up. - dit(bf(keysym.)em(sym): em(string)) - Associate em(string) with keysym em(sym) (bf(0xFF00 - 0xFFFF)). It - may contain escape values (\a: bell, \b: backspace, \e, \E: escape, - \n: newline, \r: return, \t: tab, \000: octal number) or control - characters (^?: delete, ^@: null, ^A ...) and may enclosed with - double quotes so that it can start or end with whitespace. The - intervening resource name bf(keysym.) cannot be omitted. This - resource is only available when compiled with KEYSYM_RESOURCE. -enddit() diff --git a/doc/yodl/rxvt-scrollbar.yo b/doc/yodl/rxvt-scrollbar.yo deleted file mode 100644 index 9a5afccd5945a90cdc931dba6eb4f5d6a18a79c7..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvt-scrollbar.yo +++ /dev/null @@ -1,13 +0,0 @@ -COMMENT(-- $Id: rxvt-scrollbar.yo,v 1.3 2004/03/14 21:59:58 pcg Exp $ --) -COMMENT(----------------------------------------------------------------------) -manpagesection(THE SCROLLBAR) - -Lines of text that scroll off the top of the bf(RXVTNAME()) window (resource: -bf(saveLines)) and can be scrolled back using the scrollbar or by keystrokes. -The normal bf(RXVTNAME()) scrollbar has arrows and its behaviour is fairly -intuitive. The bf(xterm-scrollbar) is without arrows and its behaviour -mimics that of em(xterm) - -Scroll down with bf(Button1) (bf(xterm-scrollbar)) or bf(Shift-Next). -Scroll up with bf(Button3) (bf(xterm-scrollbar)) or bf(Shift-Prior). -Continuous scroll with bf(Button2). diff --git a/doc/yodl/rxvt-textselection.yo b/doc/yodl/rxvt-textselection.yo deleted file mode 100644 index e71b4ba49ed651ef786b8a00c04ef76393bb774a..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvt-textselection.yo +++ /dev/null @@ -1,18 +0,0 @@ -COMMENT(-- $Id: rxvt-textselection.yo,v 1.3 2004/03/14 21:59:58 pcg Exp $ --) -COMMENT(----------------------------------------------------------------------) -manpagesection(TEXT SELECTION AND INSERTION) - -The behaviour of text selection and insertion mechanism is similar to -em(xterm)(1). - -startdit() - dit(bf(Selection):) - Left click at the beginning of the region, drag to the end of the - region and release; Right click to extend the marked region; - Left double-click to select a word; Left triple-click to select - the entire line. - dit(bf(Insertion):) - Pressing and releasing the Middle mouse button (or bf(Shift-Insert)) - in an bf(RXVTNAME()) window causes the current text selection to be inserted - as if it had been typed on the keyboard. -enddit() diff --git a/doc/yodl/rxvt.yo b/doc/yodl/rxvt.yo deleted file mode 100644 index c1ce7a3a864308649a635fcdeaac210b910fb1dd..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvt.yo +++ /dev/null @@ -1,115 +0,0 @@ -COMMENT(-- $Id: rxvt.yo,v 1.7 2004/04/02 19:16:48 pcg Exp $ --) -includefile(versioninfo.yo) -includefile(masonyodl.yo) -mailto(gcw@pobox.com) - -DEFINEMACRO(HOTKEY)(0)(Alt) -DEFINEMACRO(BIGFONT)(0)(>) -DEFINEMACRO(SMALLFONT)(0)(<) - -COMMENT(----------------------------------------------------------------------- --- We want the following macro's to be pre-defined --- RXVTNAME() --- RXVTDATE() --- RXVTVERSION() --- RXVTMAINT() --- RXVTMAINTEMAIL() --- RXVTWEBPAGE() --- RXVTWEBMAINT() --- RXVTWEBMAINTEMAIL() --- RXVTFTPSITE() -------------------------------------------------------------------------------) - -COMMENT(----------------------------------------------------------------------) -manpage(RXVT)(1)(RXVTDATE())(X Version 11)(X Tools) -manpagename(rxvt-unicode (ouR XVT, unicode))(a VT102 emulator for the X window system) - -COMMENT(----------------------------------------------------------------------) -manpagesynopsis() - -bf(RXVTNAME()) [options] [-e command [ args ]] - -COMMENT(----------------------------------------------------------------------) -manpagedescription() - -bf(rxvt-unicode), version bf(RXVTVERSION()), is a colour vt102 terminal emulator -intended as an em(xterm)(1) replacement for users who do not require -features such as Tektronix 4014 emulation and toolkit-style configurability. -As a result, bf(rxvt-unicode) uses much less swap space -- a significant -advantage on a machine serving many X sessions. - -COMMENT(----------------------------------------------------------------------) - -includefile(rxvt-options.yo) -includefile(rxvt-resources.yo) -includefile(rxvt-scrollbar.yo) -includefile(rxvt-mousereporting.yo) -includefile(rxvt-textselection.yo) -includefile(rxvt-fonts.yo) -includefile(rxvt-login.yo) -includefile(rxvt-colours.yo) -includefile(rxvt-environment.yo) -includefile(rxvt-files.yo) - -COMMENT(----------------------------------------------------------------------) -manpageseealso() - -em(xterm)(1), em(sh)(1), em(resize)(1), em(X)(1), em(pty)(4), em(tty)(4), -em(utmp)(5) - -See rxvtRef.html rxvtRef.txt for detailed information on recognized escape -sequences and menuBar syntax, etc. - -COMMENT(----------------------------------------------------------------------) -manpagebugs() - -Check the BUGS file for an up-to-date list. - -Cursor change support is not yet implemented. - -Click-and-drag doesn't work with X11 mouse report overriding. - - -COMMENT(----------------------------------------------------------------------) -manpagesection(FTP LOCATION) - -rxvt-+RXVTVERSION().tar.gz can be found at the following ftp sites -url(RXVTFTPSITE())(RXVTFTPSITE()) - -COMMENT(----------------------------------------------------------------------) -manpagesection(CURRENT PROJECT COORDINATOR) - -startdit() - dit(Project Coordinator) - RXVTMAINT() email(RXVTMAINTEMAIL())nl()\ - dit(Web page maintainter) - RXVTWEBMAINT() email(RXVTWEBMAINTEMAIL())nl()\ - url(RXVTWEBPAGE())(RXVTWEBPAGE())nl()\ -enddit() - -COMMENT(----------------------------------------------------------------------) -manpageauthors() - -startdit() - dit(John Bovey) - University of Kent, 1992, wrote the original Xvt. - dit(Rob Nation email(<nation@rocket.sanders.lockheed.com>)) - very heavily modified Xvt and came up with Rxvt - dit(Angelo Haritsis email(<ah@doc.ic.ac.uk>)) - wrote the Greek Keyboard Input (no longer in code) - dit(mj olesen email(<olesen@me.QueensU.CA>)) - Wrote the menu system. nl()\ - Project Coordinator (changes.txt 2.11 to 2.21) - dit(Oezguer Kesim email(<kesim@math.fu-berlin.de>)) - Project Coordinator (changes.txt 2.21a to 2.4.5) - dit(Geoff Wing email(<gcw@pobox.com>)) - Rewrote screen display and text selection routines. - Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) - dit(Marc Alexander Lehmann email(<rxvt@schmorp.de>)) - Forked rxvt-unicode, rewrote most of the display code and - internal character handling to store text in unicode, - improve xterm compatibility and apply numerous other bugfixes - and extensions. nl()\ - Project Coordinator (Changes 1.0 - ) -enddit() - diff --git a/doc/yodl/rxvtRef-csi.yo b/doc/yodl/rxvtRef-csi.yo deleted file mode 100644 index f89e8d717b53fbf4269394e1ab5f73616ebca860..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvtRef-csi.yo +++ /dev/null @@ -1,170 +0,0 @@ -COMMENT(-- $Id: rxvtRef-csi.yo,v 1.3 2004/02/22 12:58:02 pcg Exp $ --) -label(CSI) -nsect(CSI (Code Sequence Introducer) Sequences) - -startdl() - dl(bf(tt(ESC [ Ps @))) - (Insert bf(tt(Ps)) (Blank) Character(s) [default: 1] (ICH))\ -P()\ -label(ESCOBPsA) - dl(bf(tt(ESC [ Ps A))) - (Cursor Up bf(tt(Ps)) Times [default: 1] (CUU)) -P()\ - dl(bf(tt(ESC [ Ps B))) - (Cursor Down bf(tt(Ps)) Times [default: 1] (CUD))\ -label(ESCOBPsC) - dl(bf(tt(ESC [ Ps C))) - (Cursor Forward bf(tt(Ps)) Times [default: 1] (CUF)) -P()\ - dl(bf(tt(ESC [ Ps D))) - (Cursor Backward bf(tt(Ps)) Times [default: 1] (CUB)) -P()\ - dl(bf(tt(ESC [ Ps E))) - (Cursor Down bf(tt(Ps)) Times [default: 1] and to first column) -P()\ - dl(bf(tt(ESC [ Ps F))) - (Cursor Up bf(tt(Ps)) Times [default: 1] and to first column)\ -P()\ -label(ESCOBPsG) - dl(bf(tt(ESC [ Ps G))) - (Cursor to Column bf(tt(Ps)) (HPA)) -P()\ - dl(bf(tt(ESC [ Ps;Ps H))) - (Cursor Position [row;column] [default: 1;1] (CUP)) -P()\ - dl(bf(tt(ESC [ Ps I))) - (Move forward bf(tt(Ps)) tab stops [default: 1]) -P()\ - dl(bf(tt(ESC [ Ps J))) - (Erase in Display (ED) nl()\ - starttable(2)(l l)(0)\ - row(cell(bf(tt(Ps = 0)))cell(Clear Below (default)))\ - row(cell(bf(tt(Ps = 1)))cell(Clear Above))\ - row(cell(bf(tt(Ps = 2)))cell(Clear All))\ - endtable()) - dl(bf(tt(ESC [ Ps K))) - (Erase in Line (EL) nl()\ - starttable(2)(l l)(0)\ - row(cell(bf(tt(Ps = 0)))cell(Clear to Right (default)))\ - row(cell(bf(tt(Ps = 1)))cell(Clear to Left))\ - row(cell(bf(tt(Ps = 2)))cell(Clear All))\ - endtable()) - dl(bf(tt(ESC [ Ps L))) - (Insert bf(tt(Ps)) Line(s) [default: 1] (IL)) -P()\ - dl(bf(tt(ESC [ Ps M))) - (Delete bf(tt(Ps)) Line(s) [default: 1] (DL)) -P()\ - dl(bf(tt(ESC [ Ps P))) - (Delete bf(tt(Ps)) Character(s) [default: 1] (DCH)) -P()\ - dl(bf(tt(ESC [ Ps;Ps;Ps;Ps;Ps T))) - (Initiate link(hilite mouse tracking)(Mouse). em(unimplemented) - Parameters are [func;startx;starty;firstrow;lastrow].) -P()\ - dl(bf(tt(ESC [ Ps W))) - (Tabulator functions nl()\ - starttable(2)(l l)(0)\ - row(cell(bf(tt(Ps = 0)))cell(Tab Set (HTS)))\ - row(cell(bf(tt(Ps = 2)))cell(Tab Clear (TBC), Clear Current \ - Column (default)))\ - row(cell(bf(tt(Ps = 5)))cell(Tab Clear (TBC), Clear All))\ - endtable()) - dl(bf(tt(ESC [ Ps X))) - (Erase bf(tt(Ps)) Character(s) [default: 1] (ECH)) -P()\ - dl(bf(tt(ESC [ Ps Z))) - (Move backward bf(tt(Ps)) [default: 1] tab stops) -P()\ - dl(bf(tt(ESC [ Ps '))) - (== link(tt(ESC [ Ps G))(ESCOBPsG)) -P()\ - dl(bf(tt(ESC [ Ps a))) - (== link(tt(ESC [ Ps C))(ESCOBPsC))\ -P()\ -label(ESCOBPsc) - dl(bf(tt(ESC [ Ps c))) - (Send Device Attributes (DA)nl()\ - bf(tt(Ps = 0)) (or omitted) : request attributes from terminal nl()\ - returns: bf(tt(ESC[?1;2c)) (``I am a VT100 with Advanced Video - Option'')) -P()\ - dl(bf(tt(ESC [ Ps d))) - (Cursor to Line bf(tt(Ps)) (VPA)) -P()\ - dl(bf(tt(ESC [ Ps e))) - (== link(ESC [ Ps A)(ESCOBPsA)) -P()\ - dl(bf(tt(ESC [ Ps;Ps f))) - (Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]) -P()\ - dl(bf(tt(ESC [ Ps g))) - (Tab Clear (TBC) nl()\ - starttable(2)(l l)(0)\ - row(cell(bf(tt(Ps = 0)))cell(Clear Current Column (default)))\ - row(cell(bf(tt(Ps = 3)))cell(Clear All (TBC)))\ - endtable()) - dl(bf(tt(ESC [ Ps i))) - (Printing nl()\ - starttable(2)(l l)(0)\ - row(cell(bf(tt(Ps = 4)))cell(disable transparent print mode (MC4)))\ - row(cell(bf(tt(Ps = 5)))cell(enable transparent print mode (MC5) \ - em(unimplemented)))\ - endtable()) - dl(bf(tt(ESC [ Pm h)nl()tt(ESC [ Pm l))) - (Set Mode (SM) nl()Reset Mode (RM)\ - startdl() - dl(bf(tt(Ps = 4))) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Insert Mode (SMIR)))\ - row(cell(bf(tt(l)))cell(Replace Mode (RMIR)))\ - endtable()) - dl(bf(tt(Ps = 20)) em(unimplemented)) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Automatic Newline (LNM)))\ - row(cell(bf(tt(h)))cell(Normal Linefeed (LNM)))\ - endtable()) - enddl()) - dl(bf(tt(ESC [ Pm m))) - (Character Attributes (SGR) nl()\ - starttable(2)(l l)(0)\ - row(cell(bf(tt(Ps = 0)))cell(Normal (default)))\ - row(cell(bf(tt(Ps = 1 / 22)))cell(On / Off Bold (bright fg)))\ - row(cell(bf(tt(Ps = 4 / 24)))cell(On / Off Underline))\ - row(cell(bf(tt(Ps = 5 / 25)))cell(On / Off Blink (bright bg)))\ - row(cell(bf(tt(Ps = 7 / 27)))cell(On / Off Inverse))\ - row(cell(bf(tt(Ps = 30 / 40)))cell(fg/bg Black))\ - row(cell(bf(tt(Ps = 31 / 41)))cell(fg/bg Red))\ - row(cell(bf(tt(Ps = 32 / 42)))cell(fg/bg Green))\ - row(cell(bf(tt(Ps = 33 / 43)))cell(fg/bg Yellow))\ - row(cell(bf(tt(Ps = 34 / 44)))cell(fg/bg Blue))\ - row(cell(bf(tt(Ps = 35 / 45)))cell(fg/bg Magenta))\ - row(cell(bf(tt(Ps = 36 / 46)))cell(fg/bg Cyan))\ - row(cell(bf(tt(Ps = 37 / 47)))cell(fg/bg White))\ - row(cell(bf(tt(Ps = 39 / 49)))cell(fg/bg Default))\ - endtable()) - dl(bf(tt(ESC [ Ps n))) - (Device Status Report (DSR) nl()\ - starttable(2)(l l)(0)\ - row(cell(bf(tt(Ps = 5)))cell(Status Report bf(tt(ESC [ 0 n)) \ - (``OK'')))\ - row(cell(bf(tt(Ps = 6)))cell(Report Cursor Position (CPR) \ - [row;column] as bf(tt(ESC [ r ; c R))))\ - row(cell(bf(tt(Ps = 7)))cell(Request Display Name))\ - row(cell(bf(tt(Ps = 8)))cell(Request Version Number (place in \ - window title)))\ - endtable()) - dl(bf(tt(ESC [ Ps;Ps r))) - (Set Scrolling Region [top;bottom] nl()\ - [default: full size of window] (CSR)) -P()\ - dl(bf(tt(ESC [ s))) - (Save Cursor (SC)) -P()\ - dl(bf(tt(ESC [ Ps x))) - (Request Terminal Parameters (DECREQTPARM)) -P()\ - dl(bf(tt(ESC [ u))) - (Restore Cursor) -enddl() - diff --git a/doc/yodl/rxvtRef-definitions.yo b/doc/yodl/rxvtRef-definitions.yo deleted file mode 100644 index db7af35af91632fe053c3eb792cb412c3b576d0a..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvtRef-definitions.yo +++ /dev/null @@ -1,22 +0,0 @@ -COMMENT(-- $Id: rxvtRef-definitions.yo,v 1.2 2003/11/24 17:31:27 pcg Exp $ --) -label(Definitions) -nsect(Definitions) - -startdl() - dl(bf(tt(c))) - (The literal character c.) -P()\ - dl(bf(tt(C))) - (A single (required) character.) -P()\ - dl(bf(tt(Ps))) - (A single (usually optional) numeric parameter, composed of one or - more digits.) -P()\ - dl(bf(tt(Pm))) - (A multiple numeric parameter composed of any number of single numeric - parameters, separated by ; character(s).) -P()\ - dl(bf(tt(Pt))) - (A text parameter composed of printable characters.) -enddl() diff --git a/doc/yodl/rxvtRef-keycodes.yo b/doc/yodl/rxvtRef-keycodes.yo deleted file mode 100644 index 6a8adb9aa7fa5be74971c3c05fbf25d6173be2b8..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvtRef-keycodes.yo +++ /dev/null @@ -1,84 +0,0 @@ -COMMENT(-- $Id: rxvtRef-keycodes.yo,v 1.4 2004/08/11 22:38:08 root Exp $ --) -label(KeyCodes) -nsect(Key Codes) - -Note: bf(Shift) + bf(F1)-bf(F10) generates bf(F11)-bf(F20) - -Note: Partial ISO 14755-support is implemented, that means that pressing -Control and Shift together enters unicode input mode. Entering hex -digits composes a Unicode character, pressing space or releasing the -modifiers commits the keycode and every other key cancels the current -input character. Pressing and immediately releasing Control and Shift -together enters keycap entry mode: Pressing a function key (tab, return -etc..) will enter the unicode character corresponding to the given key. - -For the keypad, use bf(Shift) to temporarily override Application-Keypad -setting use bf(Num_Lock) to toggle Application-Keypad setting if bf(Num_Lock) -is off, link(escape sequences)(ESCequals) toggle Application-Keypad setting. -Also note that values of bf(Home), bf(End), bf(Delete) may have been compiled -differently on your system. - -COMMENT(-- Edited in a wide window --) -starttable(5)(l l l l l)(1)\ - row(cell( )cell(bf(Normal) )cell(bf(Shift) )cell(bf(Control) )cell(bf(Ctrl+Shift)))\ - row(cell(Tab )cell(^I )cell(ESC [ Z )cell(^I )cell(ESC [ Z))\ - row(cell(BackSpace )cell(^H )cell(^? )cell(^? )cell(^?))\ - row(cell(Find )cell(ESC [ 1 ~ )cell(ESC [ 1 $ )cell(ESC [ 1 ^ )cell(ESC [ 1 @))\ - row(cell(Insert )cell(ESC [ 2 ~ )cell(em(paste) )cell(ESC [ 2 ^ )cell(ESC [ 2 @))\ - row(cell(Execute )cell(ESC [ 3 ~ )cell(ESC [ 3 $ )cell(ESC [ 3 ^ )cell(ESC [ 3 @))\ - row(cell(Select )cell(ESC [ 4 ~ )cell(ESC [ 4 $ )cell(ESC [ 4 ^ )cell(ESC [ 4 @))\ - row(cell(Prior )cell(ESC [ 5 ~ )cell(em(scroll-up) )cell(ESC [ 5 ^ )cell(ESC [ 5 @))\ - row(cell(Next )cell(ESC [ 6 ~ )cell(em(scroll-down))cell(ESC [ 6 ^ )cell(ESC [ 6 @))\ - row(cell(Home )cell(ESC [ 7 ~ )cell(ESC [ 7 $ )cell(ESC [ 7 ^ )cell(ESC [ 7 @))\ - row(cell(End )cell(ESC [ 8 ~ )cell(ESC [ 8 $ )cell(ESC [ 8 ^ )cell(ESC [ 8 @))\ - row(cell(Delete )cell(ESC [ 3 ~ )cell(ESC [ 3 $ )cell(ESC [ 3 ^ )cell(ESC [ 3 @))\ - row(cell(F1 )cell(ESC [ 11 ~ )cell(ESC [ 23 ~ )cell(ESC [ 11 ^ )cell(ESC [ 23 ^))\ - row(cell(F2 )cell(ESC [ 12 ~ )cell(ESC [ 24 ~ )cell(ESC [ 12 ^ )cell(ESC [ 24 ^))\ - row(cell(F3 )cell(ESC [ 13 ~ )cell(ESC [ 25 ~ )cell(ESC [ 13 ^ )cell(ESC [ 25 ^))\ - row(cell(F4 )cell(ESC [ 14 ~ )cell(ESC [ 26 ~ )cell(ESC [ 14 ^ )cell(ESC [ 26 ^))\ - row(cell(F5 )cell(ESC [ 15 ~ )cell(ESC [ 28 ~ )cell(ESC [ 15 ^ )cell(ESC [ 28 ^))\ - row(cell(F6 )cell(ESC [ 17 ~ )cell(ESC [ 29 ~ )cell(ESC [ 17 ^ )cell(ESC [ 29 ^))\ - row(cell(F7 )cell(ESC [ 18 ~ )cell(ESC [ 31 ~ )cell(ESC [ 18 ^ )cell(ESC [ 31 ^))\ - row(cell(F8 )cell(ESC [ 19 ~ )cell(ESC [ 32 ~ )cell(ESC [ 19 ^ )cell(ESC [ 32 ^))\ - row(cell(F9 )cell(ESC [ 20 ~ )cell(ESC [ 33 ~ )cell(ESC [ 20 ^ )cell(ESC [ 33 ^))\ - row(cell(F10 )cell(ESC [ 21 ~ )cell(ESC [ 34 ~ )cell(ESC [ 21 ^ )cell(ESC [ 34 ^))\ - row(cell(F11 )cell(ESC [ 23 ~ )cell(ESC [ 23 $ )cell(ESC [ 23 ^ )cell(ESC [ 23 @))\ - row(cell(F12 )cell(ESC [ 24 ~ )cell(ESC [ 24 $ )cell(ESC [ 24 ^ )cell(ESC [ 24 @))\ - row(cell(F13 )cell(ESC [ 25 ~ )cell(ESC [ 25 $ )cell(ESC [ 25 ^ )cell(ESC [ 25 @))\ - row(cell(F14 )cell(ESC [ 26 ~ )cell(ESC [ 26 $ )cell(ESC [ 26 ^ )cell(ESC [ 26 @))\ - row(cell(F15 (Help) )cell(ESC [ 28 ~ )cell(ESC [ 28 $ )cell(ESC [ 28 ^ )cell(ESC [ 28 @))\ - row(cell(F16 (Menu) )cell(ESC [ 29 ~ )cell(ESC [ 29 $ )cell(ESC [ 29 ^ )cell(ESC [ 29 @))\ - row(cell(F17 )cell(ESC [ 31 ~ )cell(ESC [ 31 $ )cell(ESC [ 31 ^ )cell(ESC [ 31 @))\ - row(cell(F18 )cell(ESC [ 32 ~ )cell(ESC [ 32 $ )cell(ESC [ 32 ^ )cell(ESC [ 32 @))\ - row(cell(F19 )cell(ESC [ 33 ~ )cell(ESC [ 33 $ )cell(ESC [ 33 ^ )cell(ESC [ 33 @))\ - row(cell(F20 )cell(ESC [ 34 ~ )cell(ESC [ 34 $ )cell(ESC [ 34 ^ )cell(ESC [ 34 @))\ - row(cell( )cell( )cell( )cell( )cell(bf(Application)))\ - row(cell(Up )cell(ESC [ A )cell(ESC [ a )cell(ESC O a )cell(ESC O A))\ - row(cell(Down )cell(ESC [ B )cell(ESC [ b )cell(ESC O b )cell(ESC O B))\ - row(cell(Right )cell(ESC [ C )cell(ESC [ c )cell(ESC O c )cell(ESC O C))\ - row(cell(Left )cell(ESC [ D )cell(ESC [ d )cell(ESC O d )cell(ESC O D))\ - row(cell(KP_Enter )cell(^M )cell( )cell( )cell(ESC O M))\ - row(cell(KP_F1 )cell(ESC O P )cell( )cell( )cell(ESC O P))\ - row(cell(KP_F2 )cell(ESC O Q )cell( )cell( )cell(ESC O Q))\ - row(cell(KP_F3 )cell(ESC O R )cell( )cell( )cell(ESC O R))\ - row(cell(KP_F4 )cell(ESC O S )cell( )cell( )cell(ESC O S))\ - row(cell(XK_KP_Multiply )cell(* )cell( )cell( )cell(ESC O j))\ - row(cell(XK_KP_Add )cell(+ )cell( )cell( )cell(ESC O k))\ - row(cell(XK_KP_Separator)cell(, )cell( )cell( )cell(ESC O l))\ - row(cell(XK_KP_Subtract )cell(- )cell( )cell( )cell(ESC O m))\ - row(cell(XK_KP_Decimal )cell(. )cell( )cell( )cell(ESC O n))\ - row(cell(XK_KP_Divide )cell(/ )cell( )cell( )cell(ESC O o))\ - row(cell(XK_KP_0 )cell(0 )cell( )cell( )cell(ESC O p))\ - row(cell(XK_KP_1 )cell(1 )cell( )cell( )cell(ESC O q))\ - row(cell(XK_KP_2 )cell(2 )cell( )cell( )cell(ESC O r))\ - row(cell(XK_KP_3 )cell(3 )cell( )cell( )cell(ESC O s))\ - row(cell(XK_KP_4 )cell(4 )cell( )cell( )cell(ESC O t))\ - row(cell(XK_KP_5 )cell(5 )cell( )cell( )cell(ESC O u))\ - row(cell(XK_KP_6 )cell(6 )cell( )cell( )cell(ESC O v))\ - row(cell(XK_KP_7 )cell(7 )cell( )cell( )cell(ESC O w))\ - row(cell(XK_KP_8 )cell(8 )cell( )cell( )cell(ESC O x))\ - row(cell(XK_KP_9 )cell(9 )cell( )cell( )cell(ESC O y))\ -endtable() - -label(KeyCodes) -nsect(Key Codes) diff --git a/doc/yodl/rxvtRef-menubar.yo b/doc/yodl/rxvtRef-menubar.yo deleted file mode 100644 index 504843c8ddc1363dcb2aa157e7047f11b1125637..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvtRef-menubar.yo +++ /dev/null @@ -1,283 +0,0 @@ -COMMENT(-- $Id: rxvtRef-menubar.yo,v 1.4 2004/04/24 05:52:44 pcg Exp $ --) -label(menuBar) -nsect(menuBar) - -bf(The exact syntax used is em(almost) solidified.) nl()\ -In the menus, bf(DON'T) try to use menuBar commands that add or remove a -menuBar. - -Note that in all of the commands, the bf(em(/path/)) em(cannot) be omitted: -use bf(./) to specify a menu relative to the current menu. - -nsubsect(Overview of menuBar operation) - -For the menuBar XTerm escape sequence tt(ESC ] 703 ; Pt ST), the -syntax of tt(Pt) can be used for a variety of tasks: -startit() - it()link(Commands)(menuBarCommands) - it()link(Adding and accessing menus)(menuBarAdd) - it()link(Removing menus)(menuBarRemove) - it()link(Quick Arrows)(menuBarArrows) - it()link(Command Summary)(menuBarSummary) -endit() - -At the top level is the current menuBar which is a member of a circular -linked-list of other such menuBars. - -The menuBar acts as a parent for the various drop-down menus, which in turn, -may have labels, separator lines, menuItems and subMenus. - -The menuItems are the useful bits: you can use them to mimic keyboard input -or even to send text or escape sequences back to rxvt. - -The menuBar syntax is intended to provide a simple yet robust method of -constructing and manipulating menus and navigating through the menuBars. - -The first step is to use the tag bf([menu:em(name)]) which creates the -menuBar called em(name) and allows access. -You may now link(add)(menuBarAdd) or link(remove)(menuBarRemove) menus, -subMenus, and menuItems. Finally, use the tag bf([done]) to set the menuBar -access as bf(readonly) to prevent accidental corruption of the menus. -To re-access the current menuBar for alterations, use the tag bf([menu]), -make the alterations and then use bf([done]) - -label(menuBarCommands) -nsubsect(Commands) - -startdl() - dl(bf([menu:+em(name)])) - (access the named menuBar for creation or alteration. If a new menuBar - is created, it is called em(name) (max of 15 chars) and the current - menuBar is pushed onto the stack) -P()\ - dl(bf([menu])) - (access the current menuBar for alteration) -P()\ - dl(bf([title:+em(string)])) - (set the current menuBar's title to em(string), which may contain the - following format specifiers: nl()\ - bf(%%) : literal bf(%) character nl()\ - bf(%n) : rxvt name (as per the bf(-name) command-line option) nl()\ - bf(%v) : rxvt version) -P()\ - dl(bf([done])) - (set menuBar access as bf(readonly). nl()\ - End-of-file tag for bf([read:+em(file)]) operations.) -P()\ - dl(bf([read:+em(file)])) - (read menu commands directly from em(file) (extension ".menu" will be - appended if required.) Start reading at a line with bf([menu]) or - bf([menu:+em(name)) and continuing until bf([done]) is encountered. - - Blank and comment lines (starting with bf(#)) are ignored. - Actually, since any invalid menu commands are also ignored, almost - anything could be construed as a comment line, but this may be - tightened up in the future ... so don't count on it!.) -P()\ - dl(bf([read:+em(file);+em(name)])) - (The same as bf([read:+em(file)]), but start reading at a line with - bf([menu:+em(name)]) and continuing until bf([done:+em(name)]) or - bf([done]) is encountered.) -P()\ - dl(bf([dump])) - (dump all menuBars to the file bf(/tmp/rxvt-PID) in a format suitable - for later rereading.) -P()\ - dl(bf([rm:name]nl()[rm] [rm:]nl()[rm*] [rm:*])) - (remove the named menuBar nl()\ - remove the current menuBar nl()\ - remove all menuBars) -P()\ - dl(bf([swap])) - (swap the top two menuBars) -P()\ - dl(bf([prev]nl()[next])) - (access the previous or next menuBar) -P()\ - dl(bf([show]nl()[hide])) - (control display of the menuBar ... just like - link(ESC[ ? 10 h/l)(Priv10)) -P()\ - dl(bf([pixmap:+em(name)]nl()[pixmap:+em(name);em(scaling)])) - (set the background pixmap globally ... just like - link(ESC ] 20 ; Pt ST)(XPM) - - bf(A Future implementation em(may) make this local to the menubar)) -P()\ - dl(bf([:+em(command):])) - (ignore the menu readonly status and issue a em(command) to - link(Add/Modify)(menuBarAdd) or link(Remove)(menuBarRemove) a menu or - menuitem or change the link(Quick Arrows)(menuBarArrows); a useful - shortcut for setting the quick arrows from a menuBar.) -enddl() - -label(menuBarAdd) -nsubsect(Adding and accessing menus) - -The following commands may also be bf(+) prefixed. -startdl() - dl(bf(/+nl()./+nl()../+nl()../../)) - (access menuBar top level nl()\ - access current menu level nl()\ - access parent menu (1 level up) nl()\ - access parent menu (multiple levels up)) - dl(bf(em(/path/)menu)) - (add/access menu) - dl(bf(em(/path/)menu/*)) - (add/access menu and clear it if it exists) - dl(bf(em(/path/){-})) - (add separator) - dl(bf(em(/path/){item})) - (add bf(item) as a label) - dl(bf(em(/path/){item} action)) - (add/alter em(menuitem) with an associated em(action)) - dl(bf(em(/path/){item}{right-text})) - (add/alter em(menuitem) with bf(right-text) as the right-justified - text and as the associated em(action)) - dl(bf(em(/path/){item}{rtext} action)) - (add/alter em(menuitem) with an associated em(action) and with - bf(rtext) as the right-justified text.) -enddl() -startdl() - dl(Special characters in em(action) must be backslash-escaped:) - (bf(\a \b \E \e \n \r \t \octal)) - dl(or in control-character notation:) - (bf(^@, ^A .. ^Z .. ^_, ^?)) -enddl() - -To send a string starting with a bf(NUL) (bf(^@)) character to the program, -start em(action) with a pair of bf(NUL) characters (bf(^@^@)), the first of -which will be stripped off and the balance directed to the program. -Otherwise if em(action) begins with bf(NUL) followed by non-+bf(NUL) -characters, the leading bf(NUL) is stripped off and the balance is sent back -to rxvt. - -As a convenience for the many Emacs-type editors, em(action) may start -with bf(M-) (eg, bf(M-$) is equivalent to bf(\E$)) and a bf(CR) will be -appended if missed from bf(M-x) commands. - -As a convenience for issuing XTerm bf(ESC]) sequences from a menubar -(or quick arrow), a bf(BEL) (bf(^G)) will be appended if needed. - -startdl() - dl(For example,) - (bf(M-xapropos) is equivalent to bf(\Exapropos\r)) - dl(and) - (bf(\E]703;mona;100) is equivalent to bf(\E]703;mona;100\a)) -enddl() - -The option bf({em(right-rtext)}) will be right-justified. In the absence of -a specified action, this text will be used as the em(action) as well. - -startdl() - dl(For example,) - (bf(/File/{Open}{^X^F}) is equivalent to bf(/File/{Open}{^X^F} ^X^F)) -enddl() - -The left label em(is) necessary, since it's used for matching, -but implicitly hiding the left label (by using same name for both left -and right labels), or explicitly hiding the left label (by preceeding -it with a dot), makes it possible to have right-justified text only. -startdl() - dl(For example,) - (bf(/File/{Open}{Open} Open-File-Action)) - dl(or hiding it) - (bf(/File/{.anylabel}{Open} Open-File-Action)) -enddl() - -label(menuBarRemove) -nsubsect(Removing menus) - -startdl() - dl(bf(-/*+nl()-+em(/path)menu+nl()-+em(/path){item}+nl()-+em(/path){-})) - (remove all menus from the menuBar, the same as bf([clear])nl()\ - remove menu nl()\ - remove item nl()\ - remove separator) - dl(bf(-/path/menu/*)) - (remove all items, separators and submenus from menu) -enddl() - -label(menuBarArrows) -nsubsect(Quick Arrows) - -The menus also provide a hook for em(quick arrows) to provide easier user -access. If nothing has been explicitly set, the default is to emulate the -curror keys. The syntax permits each arrow to be altered individually or -all four at once without re-entering their common beginning/end text. For -example, to explicitly associate cursor actions with the arrows, any of -the following forms could be used: - -startdl() - dl(bf(<r>+em(Right)nl()<l>+em(Left)nl()<u>+em(Up)nl()<d>+em(Down))) - (Define actions for the respective arrow buttons) - dl(bf(<b>+em(Begin)nl()<e>+em(End))) - (Define common beginning/end parts for em(quick arrows) which used - in conjunction with the above <r> <l> <u> <d> constructs) -enddl() - -startdl() - dl(For example, define arrows individually,) - (bf(<u>\E[A nl()\ - <d>\E[B nl()\ - <r>\E[C nl()\ - <l>\E[D)) - dl(or all at once) - (bf(<u>\E[A<d>\E[B<r>\E[C<l>\E[D)) - dl(or more compactly (factoring out common parts)) - (bf(<b>\E[<u>A<d>B<r>C<l>D)) -enddl() - -label(menuBarSummary) -nsubsect(Command Summary) - -A short summary of the most em(common) commands: - -startdl() - dl([menu:name]) - (use an existing named menuBar or start a new one) - dl([menu]) - (use the current menuBar) - dl([title:string]) - (set menuBar title) - dl([done]) - (set menu access to readonly and, if reading from a file, signal EOF) - dl([done:name]) - (if reading from a file using [read:file;name] signal EOF) - dl([rm:name]+nl()[rm] [rm:]+nl()[rm*] [rm:*]) - (remove named, current, or all menuBar(s)) - dl([swap]) - (swap top two menuBars) - dl([prev]+nl()[next]) - (access the previous/next menuBar) - dl([show]+nl()[hide]) - (map/unmap menuBar) - dl([pixmap;file]+nl()[pixmap;file;scaling]) - (set a background pixmap) - dl([read:file]+nl()[read:file;name]) - (read in a menu from a file) - dl([dump]) - (dump out all menuBars to /tmp/rxvt-PID) - dl(/) - (access menuBar top level) - dl(./+nl()../+nl()../../) - (access current or parent menu level) - dl(/path/menu) - (add/access menu) - dl(/path/{-}) - (add separator) - dl(/path/{item}{rtext} action) - (add/alter menu item+nl()({rtext} and/or action, may be omitted)) - dl(-/*) - (remove all menus from the menuBar) - dl(-/path/menu) - (remove menu items, separators and submenus from menu) - dl(-/path/menu) - (remove menu) - dl(-/path/{item}) - (remove item) - dl(-/path/{-}) - (remove separator) - dl(<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End) - (menu quick arrows) -enddl() diff --git a/doc/yodl/rxvtRef-mouse.yo b/doc/yodl/rxvtRef-mouse.yo deleted file mode 100644 index 62a56f2bd52dda1522371bb0bac2b9a0d96a0a0b..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvtRef-mouse.yo +++ /dev/null @@ -1,29 +0,0 @@ -COMMENT(-- $Id: rxvtRef-mouse.yo,v 1.2 2003/11/24 17:31:27 pcg Exp $ --) -label(Mouse) -nsect(Mouse Reporting) - -startdl() - dl(bf(tt(ESC [ M <b> <x> <y>))) - (report mouse position) -enddl() -The lower 2 bits of bf(tt(<b>)) indicate the button: -startdl() - dl(Button = bf(tt((<b> - SPACE) & 3))) - (0 = Button1 pressed nl()\ - 1 = Button2 pressed nl()\ - 2 = Button3 pressed nl()\ - 3 = button released (X11 mouse report)) -enddl() - -The upper bits of bf(tt(<b>)) indicate the modifiers when the button was -pressed and are added together (X11 mouse report only): - -startdl() - dl(State = bf(tt((<b> - SPACE) & 60))) - (4 = Shift nl()\ - 8 = Meta nl()\ - 16 = Control nl()\ - 32 = Double Click em((Rxvt extension)) nl()\ - Col = bf(tt(<x> - SPACE)) nl()\ - Row = bf(tt(<y> - SPACE))) -enddl() diff --git a/doc/yodl/rxvtRef-privatemodes.yo b/doc/yodl/rxvtRef-privatemodes.yo deleted file mode 100644 index 6809ead945053f7da9b4c37b2af141d09ca176c5..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvtRef-privatemodes.yo +++ /dev/null @@ -1,164 +0,0 @@ -COMMENT(-- $Id: rxvtRef-privatemodes.yo,v 1.2 2003/11/24 17:31:27 pcg Exp $ --) -label(PrivateModes) -nsect(DEC Private Modes) - -startdl() - dl(bf(tt(ESC [ ? Pm h))) - (DEC Private Mode Set (DECSET)) -P()\ - dl(bf(tt(ESC [ ? Pm l))) - (DEC Private Mode Reset (DECRST)) -P()\ - dl(bf(tt(ESC [ ? Pm r))) - (Restore previously saved DEC Private Mode Values.) -P()\ - dl(bf(tt(ESC [ ? Pm s))) - (Save DEC Private Mode Values.) -P()\ - dl(bf(tt(ESC [ ? Pm t))) - (Toggle DEC Private Mode Values (rxvt extension).) - em(where) nl()\ -startdl() - dl(bf(tt(Ps = 1)) (DECCKM)) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Application Cursor Keys))\ - row(cell(bf(tt(l)))cell(Normal Cursor Keys))\ - endtable()) - dl(bf(tt(Ps = 2)) (ANSI/VT52 mode)) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Enter VT52 mode))\ - row(cell(bf(tt(l)))cell(Enter VT52 mode))\ - endtable()) - dl(bf(tt(Ps = 3))) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(132 Column Mode (DECCOLM)))\ - row(cell(bf(tt(l)))cell(80 Column Mode (DECCOLM)))\ - endtable()) - dl(bf(tt(Ps = 4))) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Smooth (Slow) Scroll (DECSCLM)))\ - row(cell(bf(tt(l)))cell(Jump (Fast) Scroll (DECSCLM)))\ - endtable()) - dl(bf(tt(Ps = 5))) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Reverse Video (DECSCNM)))\ - row(cell(bf(tt(l)))cell(Normal Video (DECSCNM)))\ - endtable()) - dl(bf(tt(Ps = 6))) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Origin Mode (DECOM)))\ - row(cell(bf(tt(l)))cell(Normal Cursor Mode (DECOM)))\ - endtable()) - dl(bf(tt(Ps = 7))) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Wraparound Mode (DECAWM)))\ - row(cell(bf(tt(l)))cell(No Wraparound Mode (DECAWM)))\ - endtable()) - dl(bf(tt(Ps = 8)) em(unimplemented)) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Auto-repeat Keys (DECARM)))\ - row(cell(bf(tt(l)))cell(No Auto-repeat Keys (DECARM)))\ - endtable()) - dl(bf(tt(Ps = 9)) X10 XTerm link(mouse reporting)(Mouse)) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Send Mouse X & Y on button press.))\ - row(cell(bf(tt(l)))cell(No mouse reporting.))\ - endtable())\ -label(Priv10) - dl(bf(tt(Ps = 10)) (bf(rxvt))) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(link(menuBar)(menuBar) visible))\ - row(cell(bf(tt(l)))cell(link(menuBar)(menuBar) invisible))\ - endtable()) - dl(bf(tt(Ps = 25))) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Visible cursor {cnorm/cvvis}))\ - row(cell(bf(tt(l)))cell(Invisible cursor {civis}))\ - endtable()) - dl(bf(tt(Ps = 30))) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(scrollBar visisble))\ - row(cell(bf(tt(l)))cell(scrollBar invisisble))\ - endtable()) - dl(bf(tt(Ps = 35)) (bf(rxvt))) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Allow XTerm Shift+key sequences))\ - row(cell(bf(tt(l)))cell(Disallow XTerm Shift+key sequences))\ - endtable()) - dl(bf(tt(Ps = 38)) em(unimplemented)) - (Enter Tektronix Mode (DECTEK)) - dl(bf(tt(Ps = 40))) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Allow 80/132 Mode))\ - row(cell(bf(tt(l)))cell(Disallow 80/132 Mode))\ - endtable()) - dl(bf(tt(Ps = 44)) em(unimplemented)) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Turn On Margin Bell))\ - row(cell(bf(tt(l)))cell(Turn Off Margin Bell))\ - endtable()) - dl(bf(tt(Ps = 45)) em(unimplemented)) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Reverse-wraparound Mode))\ - row(cell(bf(tt(l)))cell(No Reverse-wraparound Mode))\ - endtable()) - dl(bf(tt(Ps = 46)) em(unimplemented)) - () -P()\ - dl(bf(tt(Ps = 47))) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Use Alternate Screen Buffer))\ - row(cell(bf(tt(l)))cell(Use Normal Screen Buffer))\ - endtable()) -label(Priv66) - dl(bf(tt(Ps = 66))) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Application Keypad (DECPAM) == \ - link(tt(ESC =))(ESCequals)))\ - row(cell(bf(tt(l)))cell(Normal Keypad (DECPNM) == \ - link(tt(ESC >))(ESCequals)))\ - endtable()) - dl(bf(tt(Ps = 67))) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Backspace key sends bf(tt(BS) \ - (DECBKM))))\ - row(cell(bf(tt(l)))cell(Backspace key sends bf(tt(DEL))))\ - endtable()) - dl(bf(tt(Ps = 1000)) (X11 XTerm link(mouse reporting)(Mouse))) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Send Mouse X & Y on button press and \ - release.))\ - row(cell(bf(tt(l)))cell(No mouse reporting.))\ - endtable()) - dl(bf(tt(Ps = 1001)) (X11 XTerm link(mouse tracking)(Mouse)) \ - em(unimplemented)) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Use Hilite Mouse Tracking.))\ - row(cell(bf(tt(l)))cell(No mouse reporting.))\ - endtable()) - dl(bf(tt(Ps = 1010))) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Don't scroll to bottom on TTY output))\ - row(cell(bf(tt(l)))cell(Scroll to bottom on TTY output))\ - endtable()) - dl(bf(tt(Ps = 1011))) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Scroll to bottom when a key is \ - pressed))\ - row(cell(bf(tt(l)))cell(Don't scroll to bottom when a key is \ - pressed))\ - endtable()) - dl(bf(tt(Ps = 1047))) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Use Alternate Screen Buffer))\ - row(cell(bf(tt(l)))cell(Use Normal Screen Buffer - clear \ - Alternate Screen Buffer if returning from it))\ - endtable()) - dl(bf(tt(Ps = 1048))) - (starttable(2)(l l)(0)\ - row(cell(bf(tt(h)))cell(Save cursor position))\ - row(cell(bf(tt(l)))cell(Restore cursor position))\ - endtable()) - enddl() -enddl() - diff --git a/doc/yodl/rxvtRef-sequences.yo b/doc/yodl/rxvtRef-sequences.yo deleted file mode 100644 index 6a3977dc15007c7b6ac0fad450f35c5f1175f2af..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvtRef-sequences.yo +++ /dev/null @@ -1,77 +0,0 @@ -COMMENT(-- $Id: rxvtRef-sequences.yo,v 1.2 2003/11/24 17:31:27 pcg Exp $ --) -label(Sequences) -nsect(Escape Sequences) - -startdl() - dl(bf(tt(ESC # 8))) - (DEC Screen Alignment Test (DECALN)) -P()\ - dl(bf(tt(ESC 7)nl()tt(ESC 8))) - (Save Cursor (SC)nl()Restore Cursor)\ -P()\ -label(ESCequals) - dl(bf(tt(ESC =)nl()tt(ESC >))) - (Application Keypad (SMKX) == link(tt(ESC[?66h))(Priv66)nl()\ - Normal Keypad (RMKX) == link(tt(ESC[?66l))(Priv66))nl()\ -bf(Note:) If the numeric keypad is activated, eg, bf(Num_Lock) has been - pressed, numbers or control functions are generated by the numeric keypad - (see link(Key Codes)(KeyCodes)) -P()\ - dl(bf(tt(ESC D))) - (Index (IND)) -P()\ - dl(bf(tt(ESC E))) - (Next Line (NEL)) -P()\ - dl(bf(tt(ESC H))) - (Tab Set (HTS)) -P()\ - dl(bf(tt(ESC M))) - (Reverse Index (RI)) -P()\ - dl(bf(tt(ESC N))) - (Single Shift Select of G2 Character Set (SS2): affects next character - only em(unimplemented)) -P()\ - dl(bf(tt(ESC O))) - (Single Shift Select of G3 Character Set (SS3): affects next character - only em(unimplemented)) -P()\ - dl(bf(tt(ESC Z))) - (Obsolete form of link(tt(ESC[c))(ESCOBPsc) nl()\ - returns: bf(tt(ESC[?1;2C)) em(rxvt compile-time option)) -P()\ - dl(bf(tt(ESC c))) - (Full reset (RIS)) -P()\ - dl(bf(tt(ESC n))) - (Invoke the G2 Character Set (LS2)) -P()\ - dl(bf(tt(ESC o))) - (Invoke the G3 Character Set (LS3)) -P()\ - dl(bf(tt(ESC )CHAR(40)tt( C)nl()tt(ESC )CHAR(41)tt( C)nl()tt(ESC * C)nl()\ - tt(ESC + C)nl()tt(ESC $ C))) - (Designate G0 Character Set (ISO 2022)nl()\ - Designate G1 Character Set (ISO 2022)nl()\ - Designate G2 Character Set (ISO 2022)nl()\ - Designate G3 Character Set (ISO 2022)nl()\ - Designate Kanji Character Set nl()\ - em(where) bf(tt(C)) is nl()\ - starttable(2)(l l)(0)\ - row(cell(bf(tt(C = 0)))\ - cell(DEC Special Character and Line Drawing Set))\ - row(cell(bf(tt(C = A)))\ - cell(United Kingdom (UK)))\ - row(cell(bf(tt(C = B)))\ - cell(United States (USASCII)))\ - row(cell(bf(tt(C = <)))\ - cell(Multinational character set em(unimplemented)))\ - row(cell(bf(tt(C = 5)))\ - cell(Finnish character set em(unimplemented)))\ - row(cell(bf(tt(C = C)))\ - cell(Finnish character set em(unimplemented)))\ - row(cell(bf(tt(C = K)))\ - cell(German character set em(unimplemented)))\ - endtable()) -enddl() diff --git a/doc/yodl/rxvtRef-values.yo b/doc/yodl/rxvtRef-values.yo deleted file mode 100644 index 8a6d67dd1bf9784db566699fc993ce37a20a1f6d..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvtRef-values.yo +++ /dev/null @@ -1,41 +0,0 @@ -COMMENT(-- $Id: rxvtRef-values.yo,v 1.2 2003/11/24 17:31:27 pcg Exp $ --) -label(Values) -nsect(Values) - -startdl() - dl(bf(tt(ENQ))) - (Enquiry (Ctrl-E) = Send Device Attributes (DA) nl()\ - request attributes from terminal == link(ESC[Psc)(ESCOBPsc)) -P()\ - dl(bf(tt(BEL))) - (Bell (Ctrl-G)) -P()\ - dl(bf(tt(BS))) - (Backspace (Ctrl-H)) -P()\ - dl(bf(tt(TAB))) - (Horizontal Tab (HT) (Ctrl-I)) -P()\ - dl(bf(tt(LF))) - (Line Feed or New Line (NL) (Ctrl-J)) -P()\ - dl(bf(tt(VT))) - (Vertical Tab (Ctrl-K) same as bf(tt(LF))) -P()\ - dl(bf(tt(FF))) - (Form Feed or New Page (NP) (Ctrl-L) same as bf(tt(LF))) -P()\ - dl(bf(tt(CR))) - (Carriage Return (Ctrl-M)) -P()\ - dl(bf(tt(SO))) - (Shift Out (Ctrl-N), invokes the G1 character set. nl()\ - Switch to Alternate Character Set) -P()\ - dl(bf(tt(SI))) - (Shift In (Ctrl-O), invokes the G0 character set (the default) nl()\ - Switch to Standard Character Set) -P()\ - dl(bf(tt(SPC))) - (Space Character) -enddl() diff --git a/doc/yodl/rxvtRef-xpm.yo b/doc/yodl/rxvtRef-xpm.yo deleted file mode 100644 index aed78b24087a9ff64a0c81a2986d02db7a2b9aca..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvtRef-xpm.yo +++ /dev/null @@ -1,47 +0,0 @@ -COMMENT(-- $Id: rxvtRef-xpm.yo,v 1.2 2003/11/24 17:31:27 pcg Exp $ --) -label(XPM) -nsect(XPM) - -For the XPM XTerm escape sequence bf(tt(ESC ] 20 ; Pt ST)) then value of -bf(tt(Pt)) can be the name of the background pixmap followed by a sequence of -scaling/positioning commands separated by semi-colons. The scaling/positioning -commands are as follows: - -startdl() - dl(query scale/position) - (bf(?)) -P()\ - dl(change scale and position) - (bf(WxH+X+Y)nl()\ - bf(WxH+X) (== bf(WxH+X+X))nl()\ - bf(WxH) (same as bf(WxH+50+50))nl()\ - bf(W+X+Y) (same as bf(WxW+X+Y))nl()\ - bf(W+X) (same as bf(WxW+X+X))nl()\ - bf(W) (same as bf(WxW+50+50))) -P()\ - dl(change position (absolute)) - (bf(=+X+Y)nl()\ - bf(=+X) (same as bf(=+X+Y))) -P()\ - dl(change position (relative)) - (bf(+X+Y)nl()\ - bf(+X) (same as bf(+X+Y))) -P()\ - dl(rescale (relative)) - (bf(Wx0) -> bf(W *= (W/100))nl()\ - bf(0xH) -> bf(H *= (H/100))) -enddl() - -For example: - -startdl() - dl(bf(\E]20;funky\a)) - (load bf(funky.xpm) as a tiled image) -P()\ - dl(bf(\E]20;mona;100\a)) - (load bf(mona.xpm) with a scaling of 100%) -P()\ - dl(bf(\E]20;;200;?\a)) - (rescale the current pixmap to 200% and display the image geometry in \ - the title) -enddl() diff --git a/doc/yodl/rxvtRef-xterm.yo b/doc/yodl/rxvtRef-xterm.yo deleted file mode 100644 index 0b7fe5a737a88d72d3cac55a3c5f3440ac7d2f6d..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvtRef-xterm.yo +++ /dev/null @@ -1,82 +0,0 @@ -COMMENT(-- $Id: rxvtRef-xterm.yo,v 1.8 2004/07/10 20:59:39 root Exp $ --) -COMMENT(OSC: Operating System Commands) -label(XTerm) -nsect(XTerm Operating System Commands) - -startdl() - dl(bf(tt(ESC ] Ps;Pt ST))) - (Set XTerm Parameters nl()\ - 8-bit ST: 0x9c, nl()\ - 7-bit ST sequence: ESC \ (0x1b, 0x5c), nl()\ - backwards compatible terminator BEL (0x07) is also accepted. nl() - any b(octet) can be escaped by prefixing it with SYN (0x16, ^V). nl()\ - starttable(2)(l l)(0)\ - row(cell(bf(tt(Ps = 0)))\ - cell(Change Icon Name and Window Title to bf(tt(Pt))))\ - row(cell(bf(tt(Ps = 1)))\ - cell(Change Icon Name to bf(tt(Pt))))\ - row(cell(bf(tt(Ps = 2)))\ - cell(Change Window Title to bf(tt(Pt))))\ - row(cell(bf(tt(Ps = 3)))\ - cell(If bf(tt(Pt)) starts with a bf(tt(?)), query the - (STRING) property of the window and return it. If - bf(tt(Pt)) contains a bf(tt(=)), set the named property - to the given value, else delete the specified property.))\ - row(cell(bf(tt(Ps = 4)))\ - cell(bf(tt(Pt)) is a semi-colon separated sequence of one \ - or more semi-colon separated bf(number)/bf(name) pairs, \ - where bf(number) is an index to a colour and bf(name) is \ - the name of a colour. Each pair causes the bf(number)ed \ - colour to be changed to bf(name). nl()\ - Numbers 0-7 corresponds to low-intensity (normal) colours \ - and 8-15 corresponds to high-intensity colours. \ - 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, \ - 6=cyan, 7=white))\ - row(cell(bf(tt(Ps = 10)) bf((NB: may change in future)))\ - cell(Change colour of text foreground to bf(tt(Pt))))\ - row(cell(bf(tt(Ps = 11)) bf((NB: may change in future)))\ - cell(Change colour of text background to bf(tt(Pt))))\ - row(cell(bf(tt(Ps = 12)))\ - cell(Change colour of text cursor foreground to bf(tt(Pt))))\ - row(cell(bf(tt(Ps = 13)))\ - cell(Change colour of mouse foreground to bf(tt(Pt))))\ - row(cell(bf(tt(Ps = 17)))\ - cell(Change colour of highlight characters to bf(tt(Pt))))\ - row(cell(bf(tt(Ps = 18)))\ - cell(Change colour of bold characters to bf(tt(Pt))))\ - row(cell(bf(tt(Ps = 19)))\ - cell(Change colour of underlined characters to bf(tt(Pt))))\ - row(cell(bf(tt(Ps = 20)))\ - cell(Change default background link(pixmap)(XPM) to \ - bf(tt(Pt))))\ - row(cell(bf(tt(Ps = 39)))\ - cell(Change default foreground colour to bf(tt(Pt)) \ - em(rxvt compile-time option)))\ - row(cell(bf(tt(Ps = 46)))\ - cell(Change Log File to bf(tt(Pt)) \ - em(unimplemented)))\ - row(cell(bf(tt(Ps = 49)))\ - cell(Change default background colour to bf(tt(Pt)) \ - em(rxvt compile-time option)))\ - row(cell(bf(tt(Ps = 50)))\ - cell(Set fontset to bf(tt(Pt)), with the following special \ - values of \ - bf(tt(Pt)) (bf(rxvt)) nl()\ - bf(tt(#+n)) change up bf(tt(n)) font(s) nl()\ - bf(tt(#-n)) change down bf(tt(n)) font(s) nl()\ - if bf(tt(n)) is missing of 0, a value of 1 is used nl()\ - em(empty) change to font0 nl()\ - bf(tt(n)) change to font bf(tt(n))))\ - row(cell(bf(tt(Ps = 55)))\ - cell(Log all scrollback buffer and all of screen to \ - bf(tt(Pt))))\ - row(cell(bf(tt(Ps = 701)))\ - cell(Change current locale to bf(tt(Pt)), or, if bf(tt(Pt)) is bf(tt(?)), return the current locale))\ - row(cell(bf(tt(Ps = 702)))\ - cell(find font for character, used for debugging))\ -label(OSC703) - row(cell(bf(tt(Ps = 703)))\ - cell(link(menuBar)(menuBar) command bf(tt(Pt)) \ - em(rxvt compile-time option)))\ - endtable()) -enddl() diff --git a/doc/yodl/rxvtRef.yo b/doc/yodl/rxvtRef.yo deleted file mode 100644 index 68a16a69c956d5ce91b687020ed08fcabd65ee58..0000000000000000000000000000000000000000 --- a/doc/yodl/rxvtRef.yo +++ /dev/null @@ -1,61 +0,0 @@ -COMMENT(-- $Id: rxvtRef.yo,v 1.4 2004/02/22 12:58:02 pcg Exp $ --) -mailto(gcw@pobox.com) -htmlbodyopt(BGCOLOR)(#FFFFFF) -notableofcontents() -article(Rxvt Technical Reference) - (Geoff Wing (gcw@pobox.com)) - (18 April 1998) -label(toc) -COMMENT(----------------------------------------------------------------------- --- Originally written: Mark Olesen, Fri Feb 14 14:16:00 1997 --- Converted to yodl: Geoff Wing -------------------------------------------------------------------------------) -COMMENT(--- - <meta name="Author" content="mj olesen <olesen@me.queensu.ca>"> - <meta name="Description" content="Documentation of VT, XTerm, and other escape sequences used by rxvt."> ----) -includefile(masonyodl.yo) - -startit() - it()link(Definitions)(Definitions) - it()link(Values)(Values) - it()link(Escape Sequences)(Sequences) - it()link(CSI (Code Sequence Introducer) Sequences)(CSI) - it()link(DEC Private Modes)(PrivateModes) - it()link(XTerm Operating System Commands)(XTerm) - it()link(menuBar)(menuBar) - it()link(XPM)(XPM) - it()link(Mouse Reporting)(Mouse) - it()link(Key Codes)(KeyCodes) -endit() - -Reworked from XTerm documentation and other sources -includefile(rxvtRef-definitions.yo) -link(Top)(toc) -clearpage() -includefile(rxvtRef-values.yo) -link(Top)(toc) -clearpage() -includefile(rxvtRef-sequences.yo) -link(Top)(toc) -clearpage() -includefile(rxvtRef-csi.yo) -link(Top)(toc) -clearpage() -includefile(rxvtRef-privatemodes.yo) -link(Top)(toc) -clearpage() -includefile(rxvtRef-xterm.yo) -link(Top)(toc) -clearpage() -includefile(rxvtRef-menubar.yo) -link(Top)(toc) -clearpage() -includefile(rxvtRef-xpm.yo) -link(Top)(toc) -clearpage() -includefile(rxvtRef-mouse.yo) -link(Top)(toc) -clearpage() -includefile(rxvtRef-keycodes.yo) -link(Top)(toc) diff --git a/doc/yodl/versioninfo.yo b/doc/yodl/versioninfo.yo deleted file mode 100644 index e53a3b5fc1b852afaf1a83cf4894bebb11352765..0000000000000000000000000000000000000000 --- a/doc/yodl/versioninfo.yo +++ /dev/null @@ -1,19 +0,0 @@ -COMMENT(-- $Id: versioninfo.yo,v 1.24 2004/08/10 22:36:30 root Exp $ --) -DEFINEMACRO(RXVTNAME)(0) - (rxvt) -DEFINEMACRO(RXVTDATE)(0) - (2004-08-11) -DEFINEMACRO(RXVTVERSION)(0) - (3.5) -DEFINEMACRO(RXVTMAINT)(0) - (Marc A. Lehmann) -DEFINEMACRO(RXVTMAINTEMAIL)(0) - (<rxvt@schmorp.de>) -DEFINEMACRO(RXVTWEBMAINT)(0) - (Marc A. Lehmann) -DEFINEMACRO(RXVTWEBMAINTEMAIL)(0) - (<rxvt@schmorp.de>) -DEFINEMACRO(RXVTWEBPAGE)(0) - (<http://www.sourceforge.net/projects/rxvt-unicode/>) -DEFINEMACRO(RXVTFTPSITE)(0) - (ftp://ftp.rxvt.org/pub/rxvt) diff --git a/doc/yodl/versioninfo.yo.in b/doc/yodl/versioninfo.yo.in deleted file mode 100644 index 9268106c760d04673dc8d0df6b524907b8879dd2..0000000000000000000000000000000000000000 --- a/doc/yodl/versioninfo.yo.in +++ /dev/null @@ -1,19 +0,0 @@ -COMMENT(-- $Id: versioninfo.yo.in,v 1.3 2004/03/14 21:59:58 pcg Exp $ --) -DEFINEMACRO(RXVTNAME)(0) - (@RXVT_NAME@) -DEFINEMACRO(RXVTDATE)(0) - (@RXVT_DATE@) -DEFINEMACRO(RXVTVERSION)(0) - (@RXVT_VERSION@) -DEFINEMACRO(RXVTMAINT)(0) - (@RXVT_MAINT@) -DEFINEMACRO(RXVTMAINTEMAIL)(0) - (@RXVT_MAINTEMAIL@) -DEFINEMACRO(RXVTWEBMAINT)(0) - (@RXVT_WEBMAINT@) -DEFINEMACRO(RXVTWEBMAINTEMAIL)(0) - (@RXVT_WEBMAINTEMAIL@) -DEFINEMACRO(RXVTWEBPAGE)(0) - (@RXVT_WEBPAGE@) -DEFINEMACRO(RXVTFTPSITE)(0) - (ftp://@RXVT_FTPSITENAME@@RXVT_FTPSITEDIR@) diff --git a/doc/yodl/versionyodl.yo b/doc/yodl/versionyodl.yo deleted file mode 100644 index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..0000000000000000000000000000000000000000
-----END OF PAGE-----
-- Response ended
-- Page fetched on Sun Jun 2 14:00:13 2024