summaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
authorElijah Newren <newren gmail com>2006-02-12 00:55:57 +0000
committerElijah Newren <newren@src.gnome.org>2006-02-12 00:55:57 +0000
commit0e8c8eb6b5f3c1648655209f09211a3c82b243f7 (patch)
tree918596dcb8da2c83ac716c9adf80cab3ebd8e962 /doc/man
parentcb298b9279da875743f888f4113e448e2e6d16f4 (diff)
downloadmetacity-0e8c8eb6b5f3c1648655209f09211a3c82b243f7.tar.gz
metacity-0e8c8eb6b5f3c1648655209f09211a3c82b243f7.tar.bz2
Add a man page for metacity. Original version taken from Debian (written
2006-02-11 Elijah Newren <newren gmail com> Add a man page for metacity. Original version taken from Debian (written by Thom May and Akira Tagoh) and updated by Luke Morton and Philip O'Brien. Necessary auto-fu supplied by Philip O'Brien. Fixes #321279.
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/Makefile.am2
-rw-r--r--doc/man/metacity.160
2 files changed, 61 insertions, 1 deletions
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index afdbf62..e4e7d64 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -1,3 +1,3 @@
-man_MANS = metacity-theme-viewer.1 metacity-window-demo.1
+man_MANS = metacity.1 metacity-theme-viewer.1 metacity-window-demo.1
EXTRA_DIST = $(man_MANS)
diff --git a/doc/man/metacity.1 b/doc/man/metacity.1
new file mode 100644
index 0000000..3232ade
--- /dev/null
+++ b/doc/man/metacity.1
@@ -0,0 +1,60 @@
+.\" Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH METACITY 1 "11 February 2006"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh disable hyphenation
+.\" .hy enable hyphenation
+.\" .ad l left justify
+.\" .ad b justify to both left and right margins
+.\" .nf disable filling
+.\" .fi enable filling
+.\" .br insert line break
+.\" .sp <n> insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+METACITY \- minimal GTK2 Window Manager
+.SH SYNOPSIS
+.B metacity
+[\-\-display=\fIDISPLAY\fP] [\-\-replace] [\-\-sm\-client\-id=\fIID\fP] [\-\-sm\-disable] [\-\-sm\-save\-file=\fIFILENAME\fP] [\-\-version] [\-\-help]
+.SH DESCRIPTION
+This manual page documents briefly
+.B metacity\fP.
+.PP
+.\" TeX users may be more comfortable with the \fB<whatever>\fP and
+.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
+.\" respectively.
+\fBmetacity\fP is a minimal X window manager aimed at nontechnical users and is designed to integrate well with the GNOME desktop. \fBmetacity\fP lacks some features that may be expected by traditional UNIX or other technical users; these users may want to investigate other available window managers for use with GNOME or standalone.
+.SH OPTIONS
+.TP
+.B \-\-display=DISPLAY
+Connect to X display \fIDISPLAY\fP.
+.TP
+.B \-\-replace
+a window manager which is running is replaced by \fBmetacity\fP. Users are encouraged to change the GNOME window manager by running the new WM with the --replace or -replace option, and subsequently saving the session.
+.TP
+.B \-\-sm\-client\-id=ID
+Specify a session management \fIID\fP.
+.TP
+.B \-\-sm\-disable
+Disable the session management.
+.TP
+.B \-\-sm\-save\-file=FILENAME
+Load a session from \fIFILENAME\fP.
+.TP
+.B \-\-version
+Print the version number.
+.TP
+.B \-?, \-\-help
+Show summary of options.
+.SH CONFIGURATION
+\fBmetacity\fP configuration can be found under \fIPreferences\fP->\fIWindows\fP and \fIPreferences\fP->\fIKeyboard Shortcuts\fP on the menu-panel. Advanced configuration can be achieved directly through gconf editing (gconf-editor or gconftool-2).
+.SH SEE ALSO
+.BR metacity-message (1)
+.SH AUTHOR
+The original manual page was written by Thom May <thom@debian.org>. It was updated by Akira TAGOH <tagoh@debian.org>
+for the Debian GNU/Linux system (with permission to use by others), and then updated by Luke Morton and Philip O'Brien
+for inclusion in metacity.