chiark / gitweb /
vtwm (5.4.7-3) unstable; urgency=medium
[vtwm.git] / doc / vtwm.man
index c6a26b79abaf628c4c54715a72748ebef344b12b..93f6fb064c7b9c0d68b05c82ad6b71f9822e9720 100644 (file)
@@ -1,19 +1,27 @@
-.\" twm
-.\" .de EX              \"Begin example
-.\" .ne 5
-.\" .if n .sp 1
-.\" .if t .sp .5
-.\" .nf
-.\" .in +.5i
-.\" ..
-.\" .de EE
-.\" .fi
-.\" .in -.5i
-.\" .if n .sp 1
-.\" .if t .sp .5
-.\" ..
-.\" .ta .3i .6i .9i 1.2i 1.5i 1.8i
-.TH VTWM 1 "Release 5.4.7" "X11R4-6"
+.\"       Copyright 1988 by Evans & Sutherland Computer Corporation,
+.\"                          Salt Lake City, Utah
+.\"  Portions Copyright 1989 by the Massachusetts Institute of Technology
+.\"                        Cambridge, Massachusetts
+.\"
+.\"                           All Rights Reserved
+.\"
+.\"    Permission to use, copy, modify, and distribute this software and
+.\"    its documentation  for  any  purpose  and  without  fee is hereby
+.\"    granted, provided that the above copyright notice appear  in  all
+.\"    copies and that both  that  copyright  notice  and  this  permis-
+.\"    sion  notice appear in supporting  documentation,  and  that  the
+.\"    names of Evans & Sutherland and M.I.T.  not be used in advertising
+.\"    in publicity pertaining to distribution of the  software  without
+.\"    specific, written prior permission.
+.\"
+.\"    EVANS & SUTHERLAND AND M.I.T.  DISCLAIM ALL WARRANTIES WITH REGARD
+.\"    TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES  OF  MERCHANT-
+.\"    ABILITY  AND  FITNESS,  IN  NO  EVENT SHALL EVANS & SUTHERLAND OR
+.\"    M.I.T.  BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL  DAM-
+.\"    AGES OR  ANY DAMAGES WHATSOEVER  RESULTING FROM LOSS OF USE, DATA
+.\"    OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+.\"    TORTIOUS ACTION, ARISING OUT OF OR IN  CONNECTION  WITH  THE  USE
+.\"    OR PERFORMANCE OF THIS SOFTWARE.
 .\"*********************************************************************
 .\" Important note: At the time 5.4.4 was released, this manual page
 .\" conformed to Sun's guidelines for manual page markup, passed
 .\" in subsequent edits to preserve these important invariants!
 .\"*********************************************************************
 .\"=====================================================================
+.TH vtwm 1 "2005-06-28" "VTWM 5.4.7"
 .SH NAME
 .PP
 vtwm - Virtual Tab Window Manager for the X Window System
 .PP
 .\"=====================================================================
-.SH SYNTAX
-.PP
-\&\fBvtwm\fP [\fB-d\fP \fIdisplay\fP] [\fB-f\fP [\fIinitfile\fP]]
-[\fB-m\fP [\fIoptions\fP]] [\fB-p\fP] [\fB-s\fP] [\fB-v\fP]
-.PP
+.SH SYNOPSIS
+.B vtwm
+[
+.B \-d
+.I display
+]
+[
+.B \-f
+.I initfile
+]
+[
+.B \-m
+[
+.I m4-options
+]
+]
+[
+.B \-p
+]
+[
+.B \-s
+]
+[
+.B \-v
+]
 .\"=====================================================================
 .SH DESCRIPTION
 .PP
@@ -2552,11 +2581,22 @@ section to:
 accomplishes the same thing. This is but a simple example of RE usage,
 and as such doesn't demonstrate or leverage their capabilities.
 .\"=====================================================================
-.SH SIGNALS
-It is possible to issue a \fBf.restart\fP via a UNIX signal, to ease
-debugging of \fBvtwm\fP resource files.  To do this, send a SIGUSR1 to the
-\&\fBvtwm\fP process ID (written to \fI$HOME/vtwm.pid\fP).
-See \fBkill\fP(1) or \fBslay\fP(1).
+.SH "ASYNCHRONOUS EVENTS"
+It is possible to issue an
+.B f.restart
+via a Unix signal, to ease debugging of
+.B vtwm
+resource files.
+To do this, send a
+.I SIGUSR1
+to the
+.B vtwm
+process ID (written to
+.IR $HOME/vtwm.pid ).
+See
+.BR kill (1)
+or
+.BR slay (1).
 .\"=====================================================================
 .SH BUGS
 There are precious few safeguards against binding functions to objects
@@ -2565,65 +2605,59 @@ inappropriately, especially where the virtual desktop is concerned.
 Double clicking very fast to get the constrained move function will sometimes
 cause the window to move, even though the pointer is not moved.
 .PP
-It is possible to "lose" windows in the virtual desktop by placing them
-in a large desktop area, then shrinking the desktop so as to remove them
-from view. They are still there, of course, but are unreachable until the
-desktop is grown sufficiently large again.
+It is possible to \(oqlose\(cq windows in the virtual desktop by placing
+them in a large desktop area, then shrinking the desktop so as to remove
+them from view.
+They are still there, of course, but are unreachable until the
 .PP
-See the \fIBUGS\fP file in the distribution for others.
+See the
+.I BUGS
+file in the distribution for others.
 .\"=====================================================================
 .SH FILES
-.PP
-Searched for in the order shown:
-.RS 4
-.nf
-\&\fI$HOME/.vtwmrc.<screen number>\fP
-\&\fI$HOME/.vtwmrc\fP
-\&\fI$VTWMDIR/twm/system.vtwmrc\fP
-\&\fI$HOME/.twmrc.<screen number>\fP
-\&\fI$HOME/.twmrc\fP
-\&\fI$VTWMDIR/twm/system.twmrc\fP
-.fi
-.RE
-.PP
-.nf
-\&\fI$HOME/vtwm.pid\fP
+.PD 0
+.TP
+.IR $HOME/.vtwmrc. screen-number
+.TP
+.I $HOME/.vtwmrc
+.TP
+.I $VTWMETCMDIR/vtwm/system.vtwmrc
+.TP
+.IR $HOME/.twmrc. screen-number
+.TP
+.I $HOME/.twmrc
+.TP
+.I $VTWMETCMDIR/twm/system.vtwmrc
+are files
+.B vtwm
+will search for and use as its configuration file.
+They are searched for in the order shown, and the first readable file
+found is used.
+.PD 1
+.TP
+.I $HOME/vtwm.pid
+contains the ID of the user's
+.B vtwm
+process; see the description of the
+.B \-p
+option above.
 .fi
 .\"=====================================================================
-.SH "ENVIRONMENT VARIABLES"
-.IP "\fBDISPLAY\fP" 8
-This variable is used to determine which X server to use.  It is also set
-during \fBf.exec\fP so that programs come up on the proper screen.
-.IP "\fBHOME\fP" 8
+.SH ENVIRONMENT
+.TP
+.B DISPLAY
+This variable is used to determine which X server to use.
+It is also set during
+.B f.exec
+so that programs come up on the proper screen.
+.TP
+.B HOME
 This variable is used as the prefix for files that begin with a tilde and
-for locating the \fBvtwm\fP startup file.
-.\"=====================================================================
-.SH "SEE ALSO"
-\&\fBbitmap\fP(5),
-\&\fBctwm\fP(1),
-\&\fBm4\fP(1),
-\&\fBmwm\fP(1),
-\&\fBpixmap\fP(5),
-\&\fBre_format\fP(7) or \fBegrep\fP(1),
-\&\fBrplayd\fP(8) and \fBrplay.helpers\fP(5),
-\&\fBtvtwm\fP(1),
-\&\fBtwm\fP(1),
-\&\fBvuewm\fP(1),
-\&\fBX\fP(1),
-\&\fBxdm\fP(1),
-\&\fBxinit\fP(1),
-\&\fBxmodmap\fP(1),
-\&\fBxrdb\fP(1),
-\&\fBXserver\fP(1)
-.\"=====================================================================
-.SH COPYRIGHT
-Portions copyright 1988 Evans & Sutherland Computer Corporation; portions
-copyright 1989 Hewlett-Packard Company and the Massachusetts Institute of
-Technology; portions copyright 2001 D. J. Hawkey Jr..
-.PP
-See \fBX\fP(1) for a full statement of rights and permissions.
+for locating the
+.B vtwm
+startup file.
 .\"=====================================================================
-.SH AUTHORS AND CONTRIBUTORS
+.SH "AUTHORS AND CONTRIBUTORS"
 Tom LaStrange, Solbourne Computer; Jim Fulton, MIT X Consortium;
 Steve Pitschke, Stardent Computer; Keith Packard, MIT X Consortium;
 Dave Payne, Apple Computer; Nick Williams <njw@athena.mit.edu>;
@@ -2665,4 +2699,44 @@ Mehul N. Sanghvi <mehul@kirsun.ne.mediaone.net>,
 Tim Wiess <tim@zetaflops.net>,
 acknowledging
 Claude Lecommandeur, (ctwm), <lecom@sic.epfl.ch>
+.\"=====================================================================
+.SH COPYRIGHT
+Copyright 1988 Evans & Sutherland Computer Corporation
+.br
+Copyright 1989 Massachusetts Institute of Technology
+.br
+Copyright 1990 Dave Edmondson
+.br
+Copyright 1990 Imperial College of Science, Technology & Medicine
+.br
+Copyright 1990, 1991 Groupe Bull
+.br
+Copyright 2001 David J. Hawkey Jr.
+.PP
+See the copyright notices in the
+.B vtwm
+source distribution for copyright license statements.
+On Debian systems, these may also be found in the file
+.IR /usr/share/doc/vtwm/copyright .
+.\"=====================================================================
+.SH "SEE ALSO"
+.BR bitmap (1),
+.BR ctwm (1),
+.BR m4 (1),
+.BR mwm (1),
+.BR pixmap (1),
+.BR regex (7)
+or
+.BR egrep (1),
+.BR rplayd (8),
+.BR tvtwm (1),
+.BR twm (1),
+.BR vuewm (1),
+.BR X (1),
+.BR xdm (1),
+.BR xinit (1),
+.BR xmodmap (1),
+.BR xrdb (1),
+.BR Xserver (1)
 .\"==============================[The End]==============================
+.\" vim:set ai et sts=4 sw=4 tw=72: