Rewrite manpage

The old manpage was too simple and did not cover many of the options
supported by Midori on the command line.  Fixed that by rewriting it
almost completely, including many missing options, updating dates and
author, and improving the formatting.
This commit is contained in:
Sergio Durigan Junior 2015-08-28 21:47:26 -04:00
parent 91090b3e92
commit 7e2916f0ea

106
debian/midori.1 vendored
View file

@ -1,46 +1,122 @@
.TH MIDORI "1" "September 2007" "midori 0.0.6" "User commands" .TH MIDORI "1" "September 2015" "midori 0.5.11" "User commands"
.SH NAME .SH NAME
midori \- fast and lightweight web browser midori \- fast and lightweight Web Browser.
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\fBmidori\fR [OPTION...] [URL] \fBmidori\fR [OPTION...] [URL]
.SH DESCRIPTION .SH DESCRIPTION
\fBmidori\fR is a lightweight web browser. \fBmidori\fR is a lightweight Web Browser.
.SH OPTIONS .SH OPTIONS
.IP .IP
.SS "Application Options:" .SS "Application Options:"
.TP .TP
\fB\-v\fR, \fB\-\-version\fR \fB\-a\fR \fIADDRESS\fR\fR, \fB\-\-app\fR=\fIADDRESS\fR
Display program version
Run \fIADDRESS\fR as a web application.
.TP
\fB\-c\fR \fIFOLDER\fR, \fB\-\-config\fR=\fIFOLDER\fR
Use \fIFOLDER\fR as configuration folder.
.TP
\fB\-p\fR, \fB\-\-private\fR
Run Midori in private mode. No changes are saved in this mode.
.TP
\fB\-\-plain\fR
Plain GTK+ window with WebKit, akin to GtkLauncher.
.TP
\fB\-d\fR, \fB\-\-diagnostic\-dialog\fR
Show a diagnostic dialog.
.TP
\fB\-g\fR, \fB\-\-debug\fR
Run Midori within gdb and save a backtrace on crash. Useful when
reporting bugs against the package.
.TP
\fB\-r\fR \fIFILE\fR, \fB\-\-run\fR=\fIFILE\fR
Run \fIFILE\fR as a JavaScript.
.TP
\fB\-s\fR \fIURI\fR, \fB\-\-snapshot\fR=\fIURI\fR
Take a snapshot of \fIURI\fR.
.TP
\fB\-e\fR \fICOMMAND\fR, \fB\-\-execute\fR=\fICOMMAND\fR
Run the specified \fICOMMAND\fR. To obtain a list of supported
commands, see \fB\-\-help\-execute\fR below.
.TP
\fB\-\-help\-execute\fR
Print a list of available commands supported by \fB\-\-execute\fR.
.TP
\fB\-V\fR, \fB\-\-version\fR
Print the version of Midori.
.TP
\fB\-b\fR \fIPATTERN\fR, \fB\-\-block\-uris\fR=\fIPATTERN\fR
Block URIs according to the regular expression specified in
\fIPATTERN\fR.
.TP
\fB\-i\fR \fISECONDS\fR, \fB\-\-inactivity\-reset\fR=\fISECONDS\fR
Reset Midori after \fISECONDS\fR seconds of inactivity.
.TP .TP
\fB\-\-display\fR=\fIDISPLAY\fR \fB\-\-display\fR=\fIDISPLAY\fR
X display to use
.SS "Help Options:" X display to use.
.SS Help Options:
.TP .TP
\-?, \fB\-\-help\fR \-?, \fB\-\-help\fR
Show help options
Show help options described above.
.TP .TP
\fB\-\-help\-all\fR \fB\-\-help\-all\fR
Show all help options
Show all help options.
.TP .TP
\fB\-\-help\-gtk\fR \fB\-\-help\-gtk\fR
Show GTK+ Options
Show GTK+ Options.
.SH REPORTING BUGS .SH REPORTING BUGS
Please report comments, suggestions and bugs to christian@twotoasts.de Please report bugs using the Debian BTS <https://bugs.debian.org>.
.PP
Check for new versions at: http://software.twotoasts.de
.SH AUTHOR .SH AUTHOR
\fBMidori\fR is copyright (C) 2007 Christian Dywan. \fBMidori\fR is copyright (C) 2007 Christian Dywan.
.PP .PP
This manual page was written by Emanuele Rocca <ema@debian.org> for This manual page was completely rewritten by Sergio Durigan Junior
the Debian GNU/Linux system (but may be used by others). <sergiodj@sergiodj.net>, based on the previous version by Emanuele
Rocca <ema@debian.org>. It was written for the Debian GNU/Linux
system but may be used by others.
.PP .PP
Permission is granted to copy, distribute and/or modify this document under the Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU General Public License, Version 2 or any later version published terms of the GNU General Public License, Version 2 or any later version published