Return to xwm.1 CVS log

Up to [CSRG BSD Unix] / 43BSD / contrib / X / man

Annotation of 43BSD/contrib/X/man/xwm.1, revision 1.1

1.1     ! root        1: .TH XWM 1 "14 July 1985" "X Version 10"
        !             2: .SH NAME
        !             3: xwm - X Window System, window manager process
        !             4: .SH SYNOPSIS
        !             5: .B "xwm"
        !             6: [ -cfgmrsz ] [ +\fIfunction\fP ] [ @\fIdelta\fP ] [ fn=\fIfont\fP ] [ fi=\fIfont\fP ]
        !             7: [ \fIhost\fP:\fIdisplay\fP ]
        !             8: .SH DESCRIPTION
        !             9: .PP
        !            10: The window manager allows you to use the mouse to push a window to the
        !            11: top or bottom of the stack, turn a  window  into  an  icon,  resize  a
        !            12: window,  move a window elsewhere on the screen, attach the keyboard to
        !            13: a window (hierarchy) and circulate the window hierarchy.   The  window
        !            14: manager only manipulates top-level windows (i.e., direct decendents of
        !            15: the  root  window),  not  their  subwindows,  so  in  the   following,
        !            16: references to window refer only to top-level windows.
        !            17: .PP
        !            18: Since
        !            19: .I xwm
        !            20: does  not  have  a  window  of  its  own  it steals certain button/key
        !            21: combinations and interprets them as operations  on  existing  windows.
        !            22: The  key combination is specified on the command line with some subset
        !            23: of the options:
        !            24: .B "`c'"
        !            25: (control),
        !            26: .B "`s'"
        !            27: (shift),
        !            28: .B "`m'"
        !            29: (meta) and
        !            30: .B "`n'"
        !            31: (no-key). For example, if you specify the options
        !            32: .B "-cm"
        !            33: then the Control and Meta keys must be down at the time a mouse button
        !            34: is  depressed.   If  no  combination is specified in the command line,
        !            35: Meta is the default.  If
        !            36: .B "`n'"
        !            37: is specified anywhere in the option list all keys will be ignored.
        !            38: .PP
        !            39: For  each  mouse button, a different command is performed depending on
        !            40: whether the button is `clicked' or `moved', i.e., whether the mouse is
        !            41: moved  between  the  press  and  release  of  the button.  Some actual
        !            42: movement is allowed before the mouse  is  really  considered  to  have
        !            43: moved,  the  amount  of  movement  is settable (see below).  The mouse
        !            44: buttons perform the  commands  described  below.   For  any  of  these
        !            45: commands,  if  you press a button to start a command, and then want to
        !            46: abort the command, simply  press  one  of  the  other  buttons  before
        !            47: releasing the first button.  As each command is  being  performed  the
        !            48: mouse cursor will be changed to indicate which command is in effect.
        !            49: .PP
        !            50: If  the  left  button is clicked in a window it will `push' the window
        !            51: you are pointing at to the bottom of any stack of overlapping windows.
        !            52: If  clicked  on  the  root window a `circulate down' operation will be
        !            53: performed on the root  window  moving  the  top  most  window  in  the
        !            54: hierarchy to the bottom.  For any of these operations the mouse cursor
        !            55: will be a `dot'.
        !            56: .PP
        !            57: The left button will also `iconify' the window you point at if  it  is
        !            58: pressed  down  and then moved. When you release the button, the window
        !            59: will be made into an icon at  the  current  mouse  location.   If  the
        !            60: window  being iconified has its own icon, then that icon will be used.
        !            61: If not
        !            62: .I xwm
        !            63: will create and maintain its own text  icon  using  the  name  of  the
        !            64: window   as   the initial text.  For any of these operations the mouse
        !            65: cursor will be an `icon' cursor.
        !            66: .PP
        !            67: The name displayed in an 
        !            68: .I xwm
        !            69: owned text icon can be edited at any time
        !            70: by   placing   the   mouse   cursor  in  the  icon  and typing.  Note:
        !            71: Modifying text displayed in an icon window will modify the name of the
        !            72: window associated with that icon. The  delete  key  deletes  the  last
        !            73: character,  Control-U  deletes  the  entire  name,  any other printing
        !            74: characters are appended to the current name.  When the mouse cursor in
        !            75: an
        !            76: .I xwm
        !            77: text icon it will be a `text' cursor (`I bar' cursor).
        !            78: .PP
        !            79: If  you  click  the middle button on an icon, the window you iconified
        !            80: will reappear in its previous position on the screen and the icon will
        !            81: disappear.   For  this  operation  the  mouse cursor will be an `arrow
        !            82: cross' cursor.
        !            83: .PP
        !            84: The  middle button is used to resize a window by moving a corner or an
        !            85: edge.  If you press it on a window, a rubber  banded  outline  of  the
        !            86: window  will  be  displayed  (and a grid if you specify the `g' option
        !            87: explained below) and moving the mouse will change  its  size,  leaving
        !            88: the  opposite  corner  or other edges fixed.  The corner or edge to be
        !            89: moved depends on the where the mouse is when the  button  is  pressed.
        !            90: Imagine the window divided with grid of nine rectangles (the same grid
        !            91: that the `g' option displays).  If the mouse is in  one  of  the  four
        !            92: corner  rectangles or the center rectangle, then the corner closest to
        !            93: the mouse will be moved; otherwise, the closest edge  will  be  moved.
        !            94: When the button is released,  the  window  will   be   resized.    For
        !            95: these operations the mouse cursor will be an `arrow cross' cursor.
        !            96: .PP
        !            97: The  middle  button  can  also  be  used  to focus keyboard input to a
        !            98: specific window i.e., keyboard input will go to the  specified  window
        !            99: (hierarchy)  even  when  the  mouse is outside the window.  If the 'f'
        !           100: option is specified clicking the middle button twice on a window  will
        !           101: attach the keyboard to that window.  Clicking the middle button on the
        !           102: background will detach the keyboard  from  any  window  (actually,  it
        !           103: attaches  it  to the background window).  For this operation the mouse
        !           104: cursor will be an 'arrow cross' cursor.
        !           105: .PP
        !           106: The right button, if clicked in a window, will `pull' the  window  you
        !           107: are  pointing  at  to the top of any stack of overlapping windows.  If
        !           108: clicked on  the  root  window  a  `circulate  up'  operation  will  be
        !           109: performed  moving  the bottom most window in the hierarchy to the top.
        !           110: For these operations the mouse cursor will be a `circle' cursor.
        !           111: .PP
        !           112: The right button will also move the window you are pointing at  if  it
        !           113: is  pressed down and then moved.  An outline of the window (and a grid
        !           114: if you specified the 'g' option) will appear, and will move  with  the
        !           115: mouse  cursor.   When you release the right button, the window will be
        !           116: moved to the current location of the outline.  For this operation  the
        !           117: mouse cursor will be a 'circle' cursor.
        !           118: .SH OPTION SUMMARY:
        !           119: .PP
        !           120: .TP 8
        !           121: .B "c"
        !           122: The 
        !           123: .B "`c'"
        !           124: (control) option specifies that the Control key must be held down for 
        !           125: .I xwm
        !           126: to listen to mouse button operations.
        !           127: .PP
        !           128: .TP 8
        !           129: .B "f"
        !           130: The
        !           131: .B "`f'"
        !           132: (focus) option specifies that a double-click on the middle button will
        !           133: focus keyboard input events to the specified window.
        !           134: .PP
        !           135: .TP 8
        !           136: .B "g"
        !           137: The
        !           138: .b "`g'"
        !           139: (grid)  option  turns  on  a  tick-tack-toe  like  grid  that  will be
        !           140: displayed inside the `window box' during window  movement  and  resize
        !           141: operations.
        !           142: .PP
        !           143: .TP 8
        !           144: .B "m"
        !           145: The 
        !           146: .B "`m'"
        !           147: (meta)  option  specifies  that the Meta key must be held down for
        !           148: .I xwm
        !           149: to listen to mouse button operations.
        !           150: .PP
        !           151: .TP 8
        !           152: .B "n"
        !           153: The 
        !           154: .B "`n'"
        !           155: (no-key)  option  specifies  no  keys may be down when performing mouse
        !           156: button operation.
        !           157: .PP
        !           158: .TP 8
        !           159: .B "r"
        !           160: The
        !           161: .B "`r'"
        !           162: (reverse) option indicates that icons should  be  displayed  as  white
        !           163: text  on  a  black  background,  rather  than  black  text  on a white
        !           164: background.
        !           165: .PP
        !           166: .TP 8
        !           167: .B "s"
        !           168: The 
        !           169: .B "`s'"
        !           170: (shift) options indicates that the Shift key must be held down for 
        !           171: .I xwm
        !           172: to listen to mouse button operations.
        !           173: .PP
        !           174: .TP 8
        !           175: .B "z"
        !           176: The
        !           177: .B "`z'"
        !           178: (zap) option turns on a special `zap' effect that is intended to  draw
        !           179: your  attention  to  icons as they are created and windows as they are
        !           180: moved.
        !           181: .SH ARGUMENT SUMMARY:
        !           182: .PP
        !           183: .TP 8
        !           184: .B "+\fIfunction\fP"
        !           185: This argument allows you to specify a  cursor  display  function.   It
        !           186: should  be  followed  by an integer specifying the code of the display
        !           187: function.  See the Xlib document for details of  available  functions.
        !           188: The default function is GXcopy.
        !           189: .PP
        !           190: .TP 8
        !           191: \fB@\fP\fIdelta\fP
        !           192: This  argument  allows you to specify a mouse \fIdelta\fP value.  This value
        !           193: determines how far the mouse must move with a button down  before  the
        !           194: iconify,  move and  change operations begin.  The default is 5 pixels.
        !           195: Note that if you define  a  large  delta,  you  can  still  make  fine
        !           196: adjustments by first moving far away and then moving back.
        !           197: .PP
        !           198: .TP 8
        !           199: .B "fn=\fIfont\fP"
        !           200: This  argument  allow  you  to specify a text \fIfont\fP to be used in pop up
        !           201: information display.  The default font is 6x10.
        !           202: .PP
        !           203: .TP 8
        !           204: .B "fi=\fIfont\fP"
        !           205: This  argument  allow  you  to specify an icon text font.  The default
        !           206: font is 6x10.
        !           207: .PP
        !           208: .TP 8
        !           209: .B "\fIhost\fP:\fIdisplay\fP"
        !           210: This argument allow you to specify the the host and display number  on
        !           211: which
        !           212: .I xwm
        !           213: will operate.  For example `xwm orpheus:1' would start up  the  window
        !           214: manager on display one on the machine orpheus.  By default,
        !           215: .I xwm
        !           216: uses
        !           217: the host  and  display  number  stored  in  the  environment  variable
        !           218: DISPLAY,  and  therefore this argument is not normally specified.  The
        !           219: window manager can be running anywhere, and you can run more than  one
        !           220: manager per display (provided that they do not attempt to use the same
        !           221: mouse button / key combinations, see below).
        !           222: .SH X DEFAULTS
        !           223: .PP
        !           224: .TP 8
        !           225: .B BodyFont
        !           226: Set the default font for information display.
        !           227: .PP
        !           228: .TP 8
        !           229: .B IconFont
        !           230: Set the default font for text icons.
        !           231: .PP
        !           232: .TP 8
        !           233: .B InternalBorder
        !           234: Set the space between the text and window border in text icons.
        !           235: .PP
        !           236: .TP 8
        !           237: .B BorderWidth
        !           238: Set the border width of text icons.
        !           239: .PP
        !           240: .TP 8
        !           241: .B ReverseVideo
        !           242: Display text icons in reverse video?
        !           243: .SH ENVIRONMENT
        !           244: .PP
        !           245: .TP 8
        !           246: .B DISPLAY
        !           247: To get default host and display number.
        !           248: .SH SEE ALSO
        !           249: X(1), X(8C)
        !           250: .SH AUTHOR
        !           251: .PP
        !           252: Copyright 1985, Massachusetts Institute of Technology.
        !           253: .PP
        !           254: Tony Della Fera, DEC MIT Project Athena
        !           255: .PP
        !           256: Based upon previous `xwm' by Bob Scheifler, MIT Laboratory for Computer Science

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