Merge pull request #86 from hekel/master

Update Manual
author: Stefano Karapetsas <[email protected]> 2014-02-17 10:51:05 +0100
committer: Stefano Karapetsas <[email protected]> 2014-02-17 10:51:05 +0100
commit: 6880425e45a4e7856c0b8637bed5b4e6d164b70c (patch)
tree: 848988e7fc1cb4e97c90a2ce1ce8ac749f2df678
parent: 404cedc8e7dee02dca4a085b0cda446a0193b467 (diff)
parent: bee98687d69f90e831ad288fafb70fd4c4089c59 (diff)
download: marco-6880425e45a4e7856c0b8637bed5b4e6d164b70c.tar.bz2
marco-6880425e45a4e7856c0b8637bed5b4e6d164b70c.tar.xz
4 files changed, 167 insertions, 163 deletions
diff --git a/doc/man/marco-message.1 b/doc/man/marco-message.1
index 62e7a36f..9e073fa5 100644
--- a/doc/man/marco-message.1
+++ b/doc/man/marco-message.1
@@ -1,60 +1,43 @@
-.\" 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)
-.\" -----
-.\" This file was confirmed to be licenced under the GPL
-.\" by its author and copyright holder, Akira TAGOH, on June 1st 2008:
-.\"
-.\" > I'm comfortable with DFSG-free. that sounds great if you think it's
-.\" > useful and worth containing it in upstream.
-.\" ...
-.\" > Right I know. any licenses that is DFSG-free, I'm ok with whatever,
-.\" > since I have contributed that for Debian. so GPL is no problem for me.
-.\" -----
-.TH MARCO\-MESSAGE 1 "28 August 2002"
+.\" Man page for marco-message.
+.TH MARCO-MESSAGE 1 "8 February 2014" "MATE Desktop Environment"
 .\" 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
-MARCO\-MESSAGE \- a command to send a message to Marco
-.SH SYNOPSIS
-.B MARCO\-MESSAGE
-[restart|reload\-theme|enable\-keybindings|disable\-keybindings]
-.SH DESCRIPTION
-This manual page documents briefly the
-.B marco\-message\fP.
-This manual page was written for the Debian distribution
-because the original program does not have a manual page.
-.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\-message\fP send a specified message to \fBmarco\fP(1).
-.SH OPTIONS
+.SH "NAME"
+marco\-message \- A command to send messages to Marco.
+.SH "SYNOPSIS"
+.B marco\-message [OPTIONS]
+.SH "DESCRIPTION"
+The \fBmarco\-message\fP command is used to perform some simple window manager tasks while Marco is running.
+
+.SH "OPTIONS"
+.TP
+\fBrestart\fR
+Restart a currently running instance of \fBmarco\fP.
 .TP
-.B restart
-Restart \fBmarco\fP(1) which is running.
+\fBreload\-theme\fR
+Reload the current window border theme specified in the dconf database. (/org/mate/marco/general/theme)
 .TP
-.B reload-theme
-Reload a theme which is specified on mateconf database.
+\fBenable\-keybindings\fR
+Enable all keybindings specified in the dconf database. (/org/mate/marco/)
 .TP
-.B enable-keybindings
-Enable all of keybindings which is specified on mateconf database.
+\fBdisable\-keybindings\fR
+Disable all keybindings specified in the dconf database. (/org/mate/marco/)
 .TP
-.B disable-keybindings
-Disable all of keybindings which is specified on mateconf database.
-.SH SEE ALSO
-.BR marco (1)
-.SH AUTHOR
-This manual page was written by Akira TAGOH <[email protected]>,
-for the Debian GNU/Linux system (but may be used by others).
+\fBtoggle\-verbose\fR
+Enable or Disable debugging messages for \fBmarco\fR.
+
+.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 manpage were originally written for the Debian GNU/Linux system by:
+Akira TAGOH <[email protected]> (2002)
+.SH "SEE ALSO"
+.SS Further information may also be available at: http://wiki.mate-desktop.org/docs
+.P
+.BR marco (1),
+.BR marco-theme-viewer (1),
+.BR marco-window-demo (1)
diff --git a/doc/man/marco-theme-viewer.1 b/doc/man/marco-theme-viewer.1
index 6aafabda..702f36bf 100644
--- a/doc/man/marco-theme-viewer.1
+++ b/doc/man/marco-theme-viewer.1
@@ -1,43 +1,53 @@
-.\" In .TH, FOO should be all caps, SECTION should be 1-8, maybe w/ subsection
-.\" other parms are allowed: see man(7), man(1)
+.\" Man page for marco-message.
+.TH MARCO-THEME-VIEWER 1 "9 February 2014" "MATE Desktop Environment"
+.\" Please adjust this date whenever revising the manpage.
 .\"
-.\" Based on template provided by Tom Christiansen <[email protected]>.
-.\" 
-.TH MARCO-THEME-VIEWER 1 "1 June 2004" 
-.SH NAME
-marco-theme-viewer \- view marco themes
-.SH SYNOPSIS
-.B marco-theme-viewer
-[
-.I THEMENAME
-]
-.SH DESCRIPTION
-.\" Putting a newline after each sentence can generate better output.
-.B marco-theme-viewer
-allows you to preview any installed Marco theme.
+.SH "NAME"
+marco-theme-viewer \- Marco Theme Previewer
+.SH "SYNOPSIS"
+.B marco-theme-viewer [THEME]
+.SH "DESCRIPTION"
+\fBmarco-theme-viewer\fR allows you to preview any installed Marco theme.
 .PP
-When designing a new Marco theme, you can use
-.B marco-theme-viewer
-to measure the performance of a window frame option, and to preview
-the option.
-.SH OPTIONS
-.TP
-.I THEMENAME
-Name of the theme to be shown (\fIAtlanta\fR by default).
-It is case-sensitive.
-.SH FILES
+When designing a new Marco theme, you can use \fBmarco-theme-viewer\fR to benchmark the performance of a window frame, and to preview it around different types of windows in various mock scenarios.
+.SH "USAGE"
+Usage of \fBmarco-theme-viewer\fR is fairly simple. 
 .br
-.nf
+Just call \fBmarco-theme-viewer\fR followed by the Name of any valid Marco or Metacity theme installed in "~/.themes" or "/usr/share/themes".
+.br
+It is case-sensitive.
+.SH "EXAMPLE"
+\fBmarco-theme-viewer Crux\fR
+.RS 4
+Preview the Crux theme if it is installed.
+.SH "FILES"
+.TP 4
+~/.themes
+user themes directory
 .TP
-.I /usr/share/themes
+/usr/share/themes
 system themes directory
 .TP
-.I /usr/share/themes/*/marco-1/marco-theme-1.xml
-theme specification file
-.SH AUTHOR
-This manual page was written by Jose M. Moya <[email protected]>, for
-the Debian GNU/Linux system (but may be used by others).
+/usr/share/themes/*/metacity-1/metacity-theme-1.xml
+.RS 2
+\fBOR\fR
+.RE
+.RS 0
+/usr/share/themes/*/marco-1/marco-theme-1.xml
+.RS 4
+theme specification files
+.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 manpage were originally written for the Debian GNU/Linux system by: 
+Jose M. Moya <[email protected]> (2004)
 .SH "SEE ALSO"
-.\" Always quote multiple words for .SH
+.SS Further information may also be available at: http://wiki.mate-desktop.org/docs
+.P
 .BR marco (1),
-.BR marco-window-demo (1).
+.BR marco-message (1),
+.BR marco-window-demo (1)
diff --git a/doc/man/marco-window-demo.1 b/doc/man/marco-window-demo.1
index 268cb9a4..5c73b8c7 100644
--- a/doc/man/marco-window-demo.1
+++ b/doc/man/marco-window-demo.1
@@ -1,25 +1,28 @@
-.\" In .TH, FOO should be all caps, SECTION should be 1-8, maybe w/ subsection
-.\" other parms are allowed: see man(7), man(1)
+.\" Man page for marco-message.
+.TH MARCO-WINDOW-DEMO 1 "9 February 2014" "MATE Desktop Environment"
+.\" Please adjust this date whenever revising the manpage.
 .\"
-.\" Based on template provided by Tom Christiansen <[email protected]>.
-.\" 
-.TH MARCO-WINDOW-DEMO 1 "1 June 2004" 
-.SH NAME
+.SH "NAME"
 marco-window-demo \- demo of window features
-.SH SYNOPSIS
+.SH "SYNOPSIS"
 .B marco-window-demo
-.SH DESCRIPTION
-.\" Putting a newline after each sentence can generate better output.
-This program demonstrates various kinds of windows that window
-managers and window manager themes should handle.
+.SH "DESCRIPTION"
+This program demonstrates various kinds of windows that window managers and window manager themes should handle.
 .PP
 Be sure to tear off the menu and toolbar, those are also a special
 kind of window.
-.SH AUTHOR
-This manual page was written by Jose M. Moya <[email protected]>, for
-the Debian GNU/Linux system (but may be used by others).
+.SH "BUGS"
+.SS Should you encounter any bugs, they may be reported at: 
+http://github.com/mate-desktop/marco/issues
+.SH "AUTHORS"
+.SS This Manual page was originally written for the Debian GNU/Linux system by: 
+Jose M. Moya <[email protected]> (2004)
+.SS It has been updated for the MATE Desktop Environment by:
+Adam Erdman <[email protected]> (2014)
 .SH "SEE ALSO"
-.\" Always quote multiple words for .SH
-.BR x-window-manager (1),
+.SS Further information may also be available at: http://wiki.mate-desktop.org/docs
+.P
+.BR xorg (1),
 .BR marco (1),
+.BR marco-message (1),
 .BR marco-theme-viewer (1).
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)
author	Stefano Karapetsas <[email protected]>	2014-02-17 10:51:05 +0100
committer	Stefano Karapetsas <[email protected]>	2014-02-17 10:51:05 +0100
commit	6880425e45a4e7856c0b8637bed5b4e6d164b70c (patch)
tree	848988e7fc1cb4e97c90a2ce1ce8ac749f2df678
parent	404cedc8e7dee02dca4a085b0cda446a0193b467 (diff)
parent	bee98687d69f90e831ad288fafb70fd4c4089c59 (diff)
download	marco-6880425e45a4e7856c0b8637bed5b4e6d164b70c.tar.bz2 marco-6880425e45a4e7856c0b8637bed5b4e6d164b70c.tar.xz