Annotation of 43BSDReno/share/doc/ucs/X/xshell.1, revision 1.1.1.1

1.1       root        1: .TH XSHELL 1 "31 October 1985" "X Version 10"
                      2: .SH NAME
                      3: xshell - X Window System, key/button command exec
                      4: .SH SYNOPSIS
                      5: .B xshell
                      6: [ \fIoptions\fP ] [ \fIhost\fP:\fIdisplay\fP ] ...
                      7: .SH DESCRIPTION
                      8: .I Xshell
                      9: is a program for starting up X applications with a single key or button
                     10: stroke.  It displays a scallop shell icon in which button and key
                     11: presses stand for different commands.  The user can bind a command string
                     12: to any key or button by inserting a line like the following in his or her 
                     13: \fI.Xdefaults\fP file:
                     14: .PP
                     15: .nf
                     16:     xshell.action.keyname:   command to be exec'ed
                     17: .fi
                     18: .PP
                     19: Keynames are simply letters, numbers, and symbols as they appear on the
                     20: keyboard (e.g. a, $, 9), or one of the following special names (taken from 
                     21: the X keyboard definitions):
                     22: .PP
                     23: .nf
                     24:     KEYPAD0              FUNC1            E1
                     25:     KEYPAD.              FUNC2            E2
                     26:     ENTER                FUNC3            E3
                     27:     KEYPAD1              FUNC4            E4
                     28:     KEYPAD2              FUNC5            E5
                     29:     KEYPAD3              FUNC6            E6
                     30:     KEYPAD4              FUNC7            LEFTARROW
                     31:     KEYPAD5              FUNC8            RIGHTARROW
                     32:     KEYPAD6              FUNC9            DOWNARROW
                     33:     KEYPAD,              FUNC10           UPARROW
                     34:     KEYPAD7              FUNC11           SHIFT
                     35:     KEYPAD8              FUNC12           CONTROL
                     36:     KEYPAD9              FUNC13           LOCK
                     37:     KEYPAD-              FUNC14           SYMBOL
                     38:     PF1                  FUNC15
                     39:     PF2                  FUNC16
                     40:     PF3                  FUNC17
                     41:     PF4                  FUNC18
                     42:     LEFTBUTTON           FUNC19
                     43:     MIDDLEBUTTON         FUNC29
                     44:     RIGHTBUTTON
                     45: 
                     46: .fi
                     47: .PP
                     48: Thus, the following `.Xdefaults' definitions specify that the Left Button
                     49: will spawn a terminal window, the Middle Button an editor, the Right Button
                     50: a calculator, $ a Bourne shell, and # a superuser shell:
                     51: .PP
                     52: .nf
                     53:     xshell.action.LeftButton:       xterm =80x65-0+0 -fn 6x10
                     54:     xshell.action.MiddleButton:     xted =80x65+0-0 
                     55:     xshell.action.RightButton:      xterm =20x20-0-0 -fn 6x10 -e dc
                     56:     xshell.action.$:                xterm =80x65+0+0 -fn 6x10 -e sh
                     57:     xshell.action.#:                xterm =80x65+0+0 -fn 6x10 -e su
                     58: .fi
                     59: .PP
                     60: .I Xshell
                     61: breaks the command string up into words by removing all white space (i.e.
                     62: tabs and spaces) and uses the vfork() and execvp() system calls to spawn
                     63: off the command.  A more complicated parsing algorithm could easily be
                     64: added, but the current method is adequate (and fast and memory efficient).
                     65: .PP
                     66: One thing to keep in mind is that 
                     67: .I xshell
                     68: is NOT a window manager.  It was written to make popping up frequently used
                     69: utilities as painless as possible (how many times have you found that you
                     70: need just 1 more window....).  It might make a nice addition to some of
                     71: the more verbose window managers, but it runs quite nicely as a separate
                     72: program.
                     73: 
                     74: .SH ARGUMENTS
                     75: .PP
                     76: .I Xshell
                     77: is designed to be somewhat compatible with 
                     78: .I xclock
                     79: in the arguments that it takes.  However, 
                     80: .I xshell 
                     81: will allow you to abbreviate its longer flags to any length you chose.  Thus,
                     82: the \-reverse flag can be spelled out, given as \-rev, or even just \-r:
                     83: .PP
                     84: .TP 10
                     85: .B \-fg \fIcolor\fP
                     86: On color displays, determines the color of the foreground.
                     87: .PP
                     88: .TP 10
                     89: .B \-bg \fIcolor\fP
                     90: On color displays, determines the color of the background.
                     91: .PP
                     92: .TP 10
                     93: .B \-bd \fIcolor\fP
                     94: On color displays, determines the color of the border.
                     95: .PP
                     96: .TP 10
                     97: .B \-bw \fIpixels\fP
                     98: Specify the width in pixels of the border around the
                     99: .I xshell
                    100: window.
                    101: .PP
                    102: .TP 10
                    103: .B \-v\[olume\] \fIn\fP
                    104: Volume for calls to \fIXFeep\fP, used when errors (such as unbound key) are found.
                    105: .PP
                    106: .TP 10
                    107: .B \-f\[lash\] \fIn\fP
                    108: Number of times to flash the shell window to acknowledge a button or key press.
                    109: .PP
                    110: .TP 10
                    111: .B \-d\[elay\] \fIn\fP
                    112: One-hundredths of a second to wait between flashs (default is 5).
                    113: .PP
                    114: .TP 10
                    115: .B \-r\[everse\]
                    116: Reverse video (swap foreground and background).
                    117: .PP
                    118: .TP 10
                    119: .B \-q\[uiet\]
                    120: Do not `feep' on errors (see volume).
                    121: .PP
                    122: .TP 10
                    123: .B \-s\[mall\]
                    124: Use a smaller (48x48) version of the shell icon.  The default icon is 96x96.
                    125: .PP
                    126: .TP 10
                    127: .B =\fIgeometry\fP
                    128: By default 
                    129: .I xshell
                    130: will create a window the size of whatever icon you select; the standard X
                    131: window geometry argument will override this.
                    132: See \fIX(1)\fP for details.
                    133: .PP
                    134: .TP 10
                    135: .B \fIhost\fP:\fIdisplay\fP
                    136: specifies the display on which to put the
                    137: .I xshell
                    138: window.  This overrides the DISPLAY environment variable.
                    139: 
                    140: .SH X DEFAULTS
                    141: .PP
                    142: To make invoking 
                    143: .I xshell
                    144: easier, each of the flags listed above may be specified in the user's
                    145: \fI.Xdefaults\fP file:
                    146: .PP
                    147: .TP 10
                    148: .B Foreground
                    149: gives the foreground color.
                    150: .PP
                    151: .TP 10
                    152: .B Background
                    153: gives the background color.
                    154: .PP
                    155: .TP 10
                    156: .B Border
                    157: gives the border color.
                    158: .PP
                    159: .TP 10
                    160: .B BorderWidth
                    161: gives the border width.
                    162: .PP
                    163: .TP 10
                    164: .B ReverseVideo
                    165: if "on", the shell icon should be white on black instead of black on white.
                    166: .PP
                    167: .TP 10
                    168: .B Volume
                    169: gives the volume to use in calls to XFeep().
                    170: .PP
                    171: .TP 10
                    172: .B Flash
                    173: gives the number of times to flash the shell window to acknowledge key or
                    174: button presses.
                    175: .PP
                    176: .TP 10
                    177: .B Delay
                    178: gives hundredths of a second to wait in between flashes.
                    179: .PP
                    180: .TP 10
                    181: .B Quiet
                    182: prevents 
                    183: .I xshell
                    184: from feeping at you when you mistype.
                    185: .PP
                    186: .TP 10
                    187: .B IconSize
                    188: if "small", a halfsize (48x48) version of the scallopshell is used.
                    189: .PP
                    190: .TP 10
                    191: .B WindowGeometry
                    192: gives the shell window size using standard X =WxH+X+Y notation.
                    193: 
                    194: .SH ENVIRONMENT
                    195: .PP
                    196: .PP
                    197: .TP 10
                    198: .B DISPLAY
                    199: To get the default host and display number.
                    200: 
                    201: .SH SEE ALSO
                    202: xwm(1), xnwm(1), X(1), execl(3), vfork(2)
                    203: .SH DIAGNOSTICS
                    204: If 
                    205: .B \-quiet
                    206: is not given on the command line or
                    207: ``xshell.Quiet: on''
                    208: does not appear in the user's \fI.Xdefaults\fP,
                    209: .I xshell
                    210: will `feep' if a key or button is pressed for which there is no definition
                    211: in the \fI.Xdefaults\fP file.
                    212: .SH AUTHOR
                    213: .PP
                    214: Copyright 1985, Cognition Inc.
                    215: .PP
                    216: Jim Fulton (Cognition Inc.)
                    217: .SH BUGS
                    218: .I Xshell
                    219: uses the XGetDefault call to fetch the command string for a given key.  Thus,
                    220: you cannot bind the colon (``:'') character to a command.
                    221: .PP
                    222: A more `user-friendly' interface could include dialog boxes that the user
                    223: could pop up to type in a command directly so that a full shell doesn't have
                    224: to be started.  Then again, it is nice and compact now and if you really 
                    225: need to do that more than once you should use a real shell.
                    226: .PP
                    227: This program along with
                    228: \fIxwm(1)\fP and \fIxnwm\fP have been mostly superceded by \fIuwm(1)\fP.
                    229: 

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.