summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhekel <[email protected]>2014-02-17 10:49:15 +0100
committerStefano Karapetsas <[email protected]>2014-02-17 10:49:15 +0100
commite523599f7c36fec54242c718db0aaf6e402c1756 (patch)
treede810621912706bf16efc61b1f058b6e54c33f24
parent6c35ff311a1710064a7db330364bc7acaf366c7f (diff)
downloadmate-panel-e523599f7c36fec54242c718db0aaf6e402c1756.tar.bz2
mate-panel-e523599f7c36fec54242c718db0aaf6e402c1756.tar.xz
Update manpages
-rw-r--r--man/mate-desktop-item-edit.157
-rw-r--r--man/mate-panel-test-applets.160
-rw-r--r--man/mate-panel.166
3 files changed, 126 insertions, 57 deletions
diff --git a/man/mate-desktop-item-edit.1 b/man/mate-desktop-item-edit.1
index af662f6a..d3ae3d3c 100644
--- a/man/mate-desktop-item-edit.1
+++ b/man/mate-desktop-item-edit.1
@@ -1,19 +1,40 @@
-.TH "mate-desktop-item-edit" "1"
-.SH "NAME"
-mate-desktop-item-edit \(em tool to edit .desktop file
-.SH "SYNOPSIS"
+.\" Man page for mate-desktop-item-edit
+.TH MATE-DESKTOP-ITEM-EDIT 1 "4 February 2014" "MATE Desktop Environment"
+.\" Please adjust this date when revising the manpage.
+.\"
+.SH "NAME"
+mate-desktop-item-edit \- A small tool to edit .desktop files.
+.SH "SYNOPSIS"
+.B mate-desktop-item-edit [OPTIONS] [FILE]
+.SH "DESCRIPTION"
.PP
-\fBmate-desktop-item-edit\fR [\fB\-\-create-new \fP] [\fB\-\-help \fP]
-.SH "DESCRIPTION"
-.PP
-\fBmate-desktop-item-edit\fR allows you to edit .desktop file.
-.SH "OPTIONS"
-.IP "\fB\-\-create-new\fP" 10
-Create new file in the given directory.
-.IP "\fB\-\-help\fP" 10
-Display help
-.SH "AUTHOR"
-.PP
-This manual page was written by Christian Marillat [email protected] for
-the \fBDebian GNU/Linux\fP system (but may be used by others).
-.\" created by instant / docbook-to-man, Sun 03 Dec 2006, 23:24
+Distributed with mate-panel, \fBmate-desktop-item-edit\fR allows you to edit .desktop files.
+.SH "OPTIONS"
+.TP
+\fB\-\-create-new\fR
+Create a new file in the given directory.
+.TP
+\fB\-\-display=DISPLAY\fR
+X display to use.
+.TP
+\fB\-?, \-h, \-\-help\fR
+Print standard command line options.
+.TP
+\fB\-\-help\-all\fR
+Print all command line options.
+.P
+This program also accepts the standard GTK options.
+.SH "EXAMPLES"
+\fBmate-desktop-item-edit \-\-create\-new ~/Desktop/Icon.desktop\fR
+.RS 4
+Open a \fBmate-desktop-item-edit\fR dialog to create a launcher icon on the desktop named "Icon".
+.SH "BUGS"
+.SS Should you encounter any bugs, they may be reported at:
+http://github.com/mate-desktop/mate-panel/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"
+This manual page was originally written by Christian Marillat <[email protected]> for the Debian GNU/Linux system. (2006)
+.SH "SEE ALSO"
+.SS Further information may also be available at: http://wiki.mate-desktop.org/docs
diff --git a/man/mate-panel-test-applets.1 b/man/mate-panel-test-applets.1
index 28412e88..e7d4d4e9 100644
--- a/man/mate-panel-test-applets.1
+++ b/man/mate-panel-test-applets.1
@@ -1,18 +1,46 @@
-.TH "mate-panel-test-applets" "1"
-.SH "NAME"
-mate-panel-test-applets \(em display installed applets
-.SH "SYNOPSIS"
+.\" Man page for mate-panel-test-applets
+.TH MATE-PANEL-TEST-APPLETS 1 "4 February 2014" "MATE Desktop Environment"
+.\" Please adjust this date when revising the manpage.
+.SH "NAME"
+mate-panel-test-applets - display and test installed applets
+.SH "SYNOPSIS"
.PP
-\fBmate-panel-test-applets\fR [\fB\-\-help \fP]
+.B mate-panel-test-applets [OPTIONS]
.SH "DESCRIPTION"
-.PP
-\fBmate-panel-test-applets\fR display installed applets in a
-dialog box and allow you to test them.
-.SH "OPTIONS"
-.IP "\fB\-\-help\fP" 10
-Display help
-.SH "AUTHOR"
-.PP
-This manual page was written by Christian Marillat [email protected] for
-the \fBDebian GNU/Linux\fP system (but may be used by others).
-.\" created by instant / docbook-to-man, Sun 03 Dec 2006, 23:24
+\fBmate-panel-test-applets\fR display installed applets in a dialog box and allow you to test them.
+.SH "OPTIONS"
+.TP
+\fB\-\-iid\fR
+Specify an applet IID to load
+.TP
+\fB\-\-prefs-path\fR
+Specify a gsettings path in which the applet preferences should be stored
+.TP
+\fB\-\-size\fR
+Specify the initial size of the applet (xx-small, medium, large etc.)
+.TP
+\fB\-\-orient\fR
+Specify the initial orientation of the applet (top, bottom, left or right)
+.TP
+\fB\-\-display=DISPLAY\fR
+X display to use.
+.TP
+\fB\-?, \-h, \-\-help\fR
+Print standard command line options.
+.TP
+\fB\-\-help\-all\fR
+Print all command line options.
+.P
+This program also accepts the standard GTK options.
+.SH "BUGS"
+.SS Should you encounter any bugs, they may be reported at:
+http://github.com/mate-desktop/mate-panel/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"
+This manual page was originally written by Christian Marillat <[email protected]> for the Debian GNU/Linux system. (2006)
+.SH "SEE ALSO"
+.SS Further information may also be available at: http://wiki.mate-desktop.org/docs
+.P
+.BR mate-panel (1)
diff --git a/man/mate-panel.1 b/man/mate-panel.1
index 1b984ef7..43c74ca7 100644
--- a/man/mate-panel.1
+++ b/man/mate-panel.1
@@ -1,27 +1,47 @@
+.\" Man page for Mate-Panel
+.TH MATE-PANEL 1 "4 February 2014" "MATE Desktop Environment"
+.\" Please adjust this date when revising the manpage.
.\"
-.\" mate-about manual page.
-.\" (C) 2010 Vincent Untz ([email protected])
-.\"
-.TH MATE-PANEL 1 "MATE"
-.SH NAME
-mate-panel \- Display the MATE panel
-.SH SYNOPSIS
-.B mate-panel [\-\-replace]
-.SH DESCRIPTION
-The \fImate-panel\fP program provides the panels of the the MATE
-desktop.
+.SH "NAME"
+mate-panel \- The Panel for the MATE Desktop Environment
+.SH "SYNOPSIS"
+.B mate-panel [OPTIONS]
+.SH "DESCRIPTION"
+The \fBmate-panel\fR program provides the panels for the the MATE Desktop Environment. It is the area on your desktop from which you can run applications and applets, and perform other tasks. New applets may also be installed ,added to, or removed from the panels.
.PP
-The panels are the areas on the desktop that contain, among other items,
-the applications menu, application launchers, the notification area and
-the window list.
+By default, \fBmate-panel\fR typically creates a panel on the top of the screen with applets such as a Menu Bar, Notification Area, and Clock; While creating a second panel on the bottom of the screen with a Window List and a Workspace Switcher. Panels can be created, deleted, moved around the desktop, and to other monitors.
.PP
-Small applications called \fBapplets\fP can also be embedded in the
-panels. The applets usually provide quick access to specific
-features.
-.SH OPTIONS
+This manual page documents the \fBmate-panel\fR command.
+.SH "OPTIONS"
+.TP
+\fB\-\-replace\fR
+Replace a currently running instance of \fBmate-panel\fR.
+.TP
+\fB\-\-reset\fR
+Reset the panel configuration to the default setting.
+.TP
+\fB\-\-run\-dialog\fR
+Open the "Run Application" dialog, also accessible by pressing ALT+F2.
+.TP
+\fB\-\-display=DISPLAY\fR
+X display to use.
+.TP
+\fB\-?, \-h, \-\-help\fR
+Print standard command line options.
.TP
-.I --replace
-Replace an already running panel.
-.SH BUGS
-If you find bugs in the \fImate-panel\fP program, please report
-these on https://github.com/mate-desktop/mate-panel/issues.
+\fB\-\-help\-all\fR
+Print all command line options.
+.P
+This program also accepts the standard GTK options.
+.SH "BUGS"
+.SS Should you encounter any bugs, they may be reported at:
+http://github.com/mate-desktop/mate-panel/issues
+.SH "AUTHORS"
+.SS This Man Page has been written for the MATE Desktop Environment by:
+Adam Erdman <[email protected].info> (2014)
+.SH "SEE ALSO"
+.SS
+Mate Panel documentation can be found under "Help" by right-clicking on \fBmate-panel\fR.
+Further information may also be available at: http://wiki.mate-desktop.org/docs
+.P
+.BR mate-panel-test-applets (1)