summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefano Karapetsas <[email protected]>2014-02-17 10:53:43 +0100
committerStefano Karapetsas <[email protected]>2014-02-17 10:53:43 +0100
commite88ba92c0b97a974dacf62056f72d70f4802512c (patch)
tree16a6f5a5ca9073b55961406898a967d034192706
parentb2de1900bd5a9631841b47d25dd63e47739db0b7 (diff)
parente008630594606d294be28952267087f4d51ba5e1 (diff)
downloadcaja-e88ba92c0b97a974dacf62056f72d70f4802512c.tar.bz2
caja-e88ba92c0b97a974dacf62056f72d70f4802512c.tar.xz
Merge pull request #257 from hekel/master
Update Manual
-rw-r--r--docs/caja-autorun-software.144
-rw-r--r--docs/caja-connect-server.176
-rw-r--r--docs/caja-file-management-properties.169
-rw-r--r--docs/caja.1121
4 files changed, 151 insertions, 159 deletions
diff --git a/docs/caja-autorun-software.1 b/docs/caja-autorun-software.1
index 64dc33db..8829d8d8 100644
--- a/docs/caja-autorun-software.1
+++ b/docs/caja-autorun-software.1
@@ -1,14 +1,36 @@
-.IX Title "caja-autorun-software 1"
-.TH caja-autorun-software 1 "26 Sep 2013"
+.\" Man page for caja-autorun-software
+.\"
+.\" This is free software; you may redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as
+.\" published by the Free Software Foundation; either version 2,
+.\" or (at your option) any later version.
+.\"
+.\" This is distributed in the hope that it will be useful, but
+.\" WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.\" GNU General Public License for more details.
+.\"
+.\"You should have received a copy of the GNU General Public License along
+.\"with this program; if not, write to the Free Software Foundation, Inc.,
+.\"51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+.\"
+.TH CAJA-AUTORUN-SOFTWARE 1 "29 January 2014" "MATE Desktop Environment" "General Manual"
+.\" Please adjust this date whenever revising the manpage.
+.\"
.SH "NAME"
-caja\-autorun\-software \- Manage Auto-run of Software with Caja
-.SH "SYNOPSIS"
-.IX Header "SYNOPSIS"
-This executable is part of the package 'caja': The \s-1MATE\s0 Desktop File Manager
+caja\-autorun\-software
.SH "DESCRIPTION"
-.IX Header "DESCRIPTION"
-This package contains Caja, the file manager for the \s-1MATE\s0
-Desktop Environment.
+This executable is provided as a part of the Caja package for the MATE Desktop Environment.
+.SH "BUGS"
+.SS Should you encounter any bugs, they may be reported at:
+http://github.com/mate-desktop/caja/issues
.SH "LICENSE"
-.IX Header "LICENSE"
-\&\s-1GPL\s0 v2 or later
+GPL v2 or later
+.SH "SEE ALSO"
+.SS
+Caja documentation can be found from the "Help" menu, or by pressing the F1 key.
+Further information may also be available at: http://wiki.mate-desktop.org/docs
+.P
+.BR "caja" (1),
+.BR "caja-connect-server" (1),
+.BR "caja-file-management-properties" (1)
diff --git a/docs/caja-connect-server.1 b/docs/caja-connect-server.1
index 5ac49b70..716134b0 100644
--- a/docs/caja-connect-server.1
+++ b/docs/caja-connect-server.1
@@ -1,50 +1,40 @@
-.\" 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 caja-connect-server 1 "05 Jan 2008"
+.\" Man page for caja-connect-server
+.TH CAJA-CONNECT-SERVER 1 "29 January 2014" "MATE Desktop Environment" "General Manual"
.\" 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
-caja-connect-server \- To Access a remote server
-.SH SYNOPSIS
-.B caja-connect-server
-.RI [ options ]
-.RI [ URI ]
-.SH DESCRIPTION
-This manual page documents briefly the
-.B caja-connect-server
-command.
+.SH "NAME"
+Caja\-connect\-server \- Connect to Server dialog for Caja
+.SH "SYNOPSIS"
+.B caja\-connect\-server [OPTIONS]
+.SH "DESCRIPTION"
+Caja Connect Server is the connection manager for Caja/MATE. It is provided as a part of the Caja package for the MATE Desktop Environment.
.PP
-Caja Connect Server is the connection manager for the MATE desktop.
+Simply running "\fBcaja\-connection\-server\fR" will open a simple dialog allowing you to select the server type, and specify the server address, port, and login credentials for the server you want to connect to. This is the same dialog accessible via the Caja "File" menu, and the MATE Desktop "Places" menu.
.PP
-You can use the file manager to access a remote server, be it an FTP site,
-a Windows share, a WebDav server or an SSH server.
-.SH OPTIONS
-Caja follows the usual GNU command line syntax, with long options starting
-with two dashes (`-'). A summary of options is included below.
+You can use the Caja file manager to access remote servers such as SSH, FTP, and WebDav (HTTP/HTTPS) Servers.
+.PP
+If you desire to mount and access remote servers via console commands, you should use \fBcaja\fR directly. See: \fBcaja\fR(1)
+.SH "OPTIONS"
.TP
-.B \-\-help
-Show a summary of options.
+\fB\-\-display=DISPLAY\fR
+X display to use.
.TP
-.B \-\-version
-Show version.
+\fB\-?, \-h, \-\-help\fR
+Print standard command line options.
.TP
-Other standard MATE options not listed here are also supported.
-.SH SEE ALSO
-Caja Connect Server documentation can be found from the "Help" menu, or by pressing the
-F1 key. Caja also has a website at http://www.gnome.org/projects/caja/
-.SH AUTHOR
-This manual page was written by Julian Andres Klode <[email protected]> for the
-Debian GNU/Linux system (but may be used by others), based on a manpage by
-Fernando Ribeiro <[email protected]>.
+\fB\-\-help\-all\fR
+Print all command line options.
+.SH "BUGS"
+.SS Should you encounter any bugs, they may be reported at:
+http://github.com/mate-desktop/caja/issues
+.SH "AUTHORS"
+.SS This Man Page has been written for the MATE Desktop Environment by:
+Adam Erdman <[email protected]> (2014)
+.SH "SEE ALSO"
+.SS
+Caja documentation can be found from the "Help" menu, or by pressing the F1 key.
+Further information may also be available at: http://wiki.mate-desktop.org/docs
+.P
+.BR "caja" (1),
+.BR "caja-autorun-software" (1),
+.BR "caja-file-management-properties" (1)
diff --git a/docs/caja-file-management-properties.1 b/docs/caja-file-management-properties.1
index 64db38d3..87b41d56 100644
--- a/docs/caja-file-management-properties.1
+++ b/docs/caja-file-management-properties.1
@@ -1,49 +1,28 @@
-.\" 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 caja-file-management-properties 1 "05 Jan 2008"
+.\" Man page for caja-file-management-properties
+.TH CAJA-FILE-MANAGEMENT-PROPERTIES 1 "29 January 2014" "MATE Desktop Environment" "General Manual"
.\" 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
-caja-file-management-properties \- File Management Preferences
-.SH SYNOPSIS
-.B caja-file-management-properties
-.RI [ options ]
-.SH DESCRIPTION
-This manual page documents briefly the
-.B caja-file-management-properties
-command.
+.SH "NAME"
+Caja\-file\-management\-properties \- Caja File Management Preferences
+.SH "SYNOPSIS"
+.B caja\-file\-management\-properties
+.SH "DESCRIPTION"
+Caja File Management Properties is distributed as a part of the caja package and is used to configure Caja's preferences. It is typically accessible through the "Edit" menu in Caja browser windows, or by pressing "ALT+E" and then "N" once the menu opens.
.PP
-File Management Preferences allows an user to configure the way caja looks.
+File Management Preferences allows the user to configure the way caja behaves.
.PP
-You can specify a default view, and select sort options and display options.
-You can also specify default settings for icon views and list views.
-.SH OPTIONS
-Caja follows the usual GNU command line syntax, with long options starting
-with two dashes (`-'). A summary of options is included below.
-.TP
-.B \-\-help
-Show a summary of options.
-.TP
-.B \-\-version
-Show version.
-.TP
-Other standard MATE options not listed here are also supported.
-.SH SEE ALSO
-File Management Preferences documentation can be found from the "Help" menu, or by pressing the
-F1 key. Caja also has a website at http://www.gnome.org/projects/caja/
-.SH AUTHOR
-This manual page was written by Julian Andres Klode <[email protected]> for the
-Debian GNU/Linux system (but may be used by others), based on a manpage by
-Fernando Ribeiro <[email protected]>.
+You can specify appearance preferences for the Default View; and defaults for Icon, Compact, List, and Tree View; and select sort options and display options. You can configure Caja to recognize Single or Double Click input; as well as Include a Delete command and menu option that bypasses the Trash. Caja File Management Preferences (\fBcaja-file-management-properties\fR) also allows you to tell Caja how to handle certain files; whether to View or Run excutable text files; Automatically view or play Media like CDs, DVDs, or photos, and which applications to use when performing these tasks. Among some other options, this dialog also allows you to adjust file-preview settings, and settings for installed plugins if they exist.
+.SH "BUGS"
+.SS Should you encounter any bugs, they may be reported at:
+http://github.com/mate-desktop/caja/issues
+.SH "AUTHORS"
+.SS This Man Page has been written for the MATE Desktop Environment by:
+Adam Erdman <[email protected]> (2014)
+.SH "SEE ALSO"
+.SS
+Caja documentation can be found from the "Help" menu, or by pressing the F1 key.
+Further information may also be available at: http://wiki.mate-desktop.org/docs
+.P
+.BR "caja" (1),
+.BR "caja-autorun-software" (1),
+.BR "caja-connect-server" (1)
diff --git a/docs/caja.1 b/docs/caja.1
index dc26cf6c..27dd9fef 100644
--- a/docs/caja.1
+++ b/docs/caja.1
@@ -1,77 +1,78 @@
-.\" 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 Caja 1 "24 May 2004"
-.\" Please adjust this date whenever revising the manpage.
+.\" Man page for Caja.
+.TH CAJA 1 "29 January 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
-caja \- the MATE File Manager
-.SH SYNOPSIS
-.B caja
-.RI [ options ] " URIs" ...
-.br
-.SH DESCRIPTION
-This manual page documents briefly the
-.B caja
-command. This manual page was written for the Debian GNU/Linux distribution
-because the original program does not have a manual page.
+.SH "NAME"
+Caja \- The MATE File Manager
+.SH "SYNOPSIS"
+.B caja [OPTIONS...] [URI...]
+.SH "DESCRIPTION"
+Caja is the default file manager for the MATE Desktop Environment. It makes it easy to manage, manipulate, and customize files and directories. Caja can access local and remote filesystems such as SSH, FTP, and WebDav (HTTP/HTTPS).
.PP
-Caja is the file manager for the MATE desktop.
-.br
-.SH OPTIONS
-Caja follows the usual GNU command line syntax, with long options starting
-with two dashes (`-'). A summary of options is included below.
+Caja also provides the desktop background and the icons it uses for launching links and applications, as well as accessing files, directories, the trash, and removeable media like CD/DVD/BD and USB drives.
+.PP
+This manual page briefly documents the \fBcaja\fR command.
+.SH "OPTIONS"
.TP
-.B \-\-browser
+\fB\-\-browser\fR
Open a browser window.
.TP
-.B \-c
-.TP
-.B \-\-check
+\fB\-c, \-\-check\fR
Perform a quick set of self-check tests.
.TP
-.B \-g
+\fB\-\-display=DISPLAY\fR
+X display to use.
.TP
-.B \-\-geometry=\fIGEOMETRY\fR
+\fB\-g, \-\-geometry=\fIGEOMETRY\fR
Create the initial window with the given geometry.
.TP
-.B \-n
-.TP
-.B \-\-no-default-window
+\fB\-n, \-\-no\-default\-window\fR
Only create windows for explicitly specified URIs.
.TP
-.B \-\-no-desktop
-Do not manage the desktop \(em ignore the preference set in the preferences
-dialog.
+\fB\-\-no\-desktop\fR
+Do not manage the desktop (ignore the preference set in the preferences dialog).
.TP
-.B \-q
-.TP
-.B \-\-quit
+\fB\-q, \-\-quit\fR
Quit Caja.
.TP
-.B \-\-help
-Show a summary of options.
+\fB\-\-version\fR
+Print current version information and exit.
.TP
-.B \-\-version
-Show Caja' version.
+\fB\-?, \-h, \-\-help\fR
+Print standard command line options.
.TP
-Other standard MATE options not listed here are also supported.
-.SH SEE ALSO
-Caja documentation can be found from the "Help" menu, or by pressing the
-F1 key. Caja also has a website at
-http://www.gnome.org/projects/caja/
-.SH AUTHOR
-This manual page was written by Takuo KITAME <[email protected]> and Dafydd
-Harries <[email protected]> for the Debian GNU/Linux system (but may be used
-by others).
+\fB\-\-help\-all\fR
+Print all command line options.
+.P
+This program also accepts the standard GTK options.
+
+.SH "EXAMPLES"
+\fBcaja ftp://ftp.kernel.org/\fR
+.RS 4
+Open a new Caja window on the Linux Kernel ftp server.
+.RE
+.PP
+\fBcaja \-\-no\-desktop /home/user/\fR
+.RS 4
+Open a Caja window in "user's" home directory without managing the desktop.
+.RE
+.PP
+\fBcaja \-g 600x400\fR
+.RS 4
+Open a Caja window that is 600 pixels wide by 400 pixels high.
+.SH "BUGS"
+.SS Should you encounter any bugs, they may be reported at:
+http://github.com/mate-desktop/caja/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 Takuo KITAME <[email protected]> and Dafydd Harries <[email protected]> to accompany the Nautilus file manager for the GNOME Desktop Environment on Debian GNU/Linux. (2004)
+.SH "SEE ALSO"
+.SS
+Caja documentation can be found from the "Help" menu, or by pressing the F1 key.
+Further information may also be available at: http://wiki.mate-desktop.org/docs
+.P
+.BR "caja-file-management-properties" (1),
+.BR "caja-autorun-software" (1),
+.BR "caja-connect-server" (1)