Merge pull request #86 from hekel/master

Update Manual

1 files changed, 66 insertions, 58 deletions

diff --git a/doc/man/marco.1 b/doc/man/marco.1
index dae50a3c..e485bd18 100644
--- a/doc/man/marco.1
+++ b/doc/man/marco.1
@@ -1,60 +1,68 @@
-.\"                                      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 MARCO 1 "11 February 2006"
-.\" Please adjust this date whenever revising the manpage.
+.\" Man page for Marco.
+.TH MARCO 1 "7 February 2014" "MATE Desktop Environment"
+.\" Please adjust this date when 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
-MARCO \- minimal GTK2 Window Manager
-.SH SYNOPSIS
-.B marco
-[\-\-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 marco\fP.
+.SH "NAME"
+Marco \- The MATE Window Manager
+.SH "SYNOPSIS"
+.B marco [OPTIONS]
+.SH "DESCRIPTION"
+Marco is a minimal X window manager that uses GTK+ for drawing window frames. It is aimed at non-technical users and is designed to integrate well with the MATE desktop. Marco is a plain window manager for the adult in you; Many window managers are like Marshmallow Froot Loops, Marco is like Cheerios. It 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 MATE or as a standalone window manager.
 .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.
-\fBmarco\fP is a minimal X window manager aimed at nontechnical users and is designed to integrate well with the MATE desktop.  \fBmarco\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 MATE 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 \fBmarco\fP.  Users are encouraged to change the MATE 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
-\fBmarco\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 mateconf editing (mateconf-editor or mateconftool-2).
-.SH SEE ALSO
-.BR marco-message (1)
-.SH AUTHOR
-The original manual page was written by Thom May <[email protected]>.  It was updated by Akira TAGOH <[email protected]>
-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 marco.
+Marco supports several somewhat advanced but common features such as Window Shading/Roll-Up, Window/Edge Snapping, Vertical and Horizontal Maximize, Always-On-Top, Sloppy/Mouse Focus and Raising, and many more... Well, not a lot, but some more.
+.PP
+This manual page documents the \fBmarco\fR command.
+
+.SH "OPTIONS"
+.TP
+\fB\-d, \-\-display=DISPLAY\fR
+X display to use.
+.TP
+\fB\-\-sync\fR
+.br
+Make X calls synchronous.
+.TP
+\fB\-\-replace\fR
+Replace the currently running window manager with Marco.
+.TP
+\fB\-\-sm\-disable\fR
+Disable the connection to the session manager.
+.TP
+\fB\-\-sm\-client\-id=ID\fR
+Specify a session management ID.
+.TP
+\fB\-\-sm\-save\-file=FILENAME\fR
+Restore from a session management savefile. 
+.br
+If no path is specified \fBmarco\fR will look in ~/.config/mate-session/saved-session/
+.TP
+\fB\-c, \-\-composite\fR
+Turn compositing ON. You may also use this option to start \fBmarco\fR with composite "true transparency" effects. 
+.TP
+\fB\-\-no\-composite\fR
+Turn compositing OFF. You may also use this option to start \fBmarco\fR without compositing effects. 
+.TP
+\fB\-\-no\-force\-fullscreen\fR
+Do not create fullscreen windows without decorations.
+.TP
+\fB\-\-version\fR
+Print current version information and exit.
+.TP
+\fB\-?, \-h, \-\-help\fR
+Print standard command line options.
+.SH "CONFIGURATION"
+Marco configuration can be found via the main MATE menus, under "\fISystem\fP->\fIPreferences\fP->\fIWindows\fP" and "\fISystem\fP->\fIPreferences\fP->\fIKeyboard Shortcuts\fP" or by running the commands \fBmate-window-properties\fR and \fBmate-keybinding-properties\fR respectively. Advanced configuration can also be achieved directly, via \fBdconf-editor\fR under "/\fIorg\fP/\fImate\fP/\fImarco\fP/".
+.SH "BUGS"
+.SS Should you encounter any bugs, they may be reported at: 
+http://github.com/mate-desktop/marco/issues
+.SH "AUTHORS"
+.SS This Man Page has been updated/re-written for the MATE Desktop Environment by:
+Adam Erdman <[email protected]> (2014)
+.SH "HISTORY"
+.SS Portions of this manual page were originally written by Luke Morton and Philip O'Brien (2006) for Metacity, but do not bear resemblance to preceding documentation.
+.SH "SEE ALSO"
+.SS Further information may also be available at: http://wiki.mate-desktop.org/docs
+.P
+.BR marco-message (1),
+.BR marco-theme-viewer (1),
+.BR marco-window-demo (1)