Codebase list debian-goodies / debian/0.35 debmany / man / debmany.1
debian/0.35

Tree @debian/0.35 (Download .tar.gz)

debmany.1 @debian/0.35raw · history · blame

.TH "DEBMANY" "1" "1.2" "Michael Arlt" "User Commands"
.SH "NAME"
debmany \- select manpages from installed packages, packages from the repository or .deb\-files for viewing using "man" or an alternative viewer.
.SH "SYNOPSIS"
.B debmany
\fI\-\-help
.br 
.B debmany
\fI[\-m manpageviewer|\-k|\-g|\-x] [\-L limit] [\-l lang1[,...]] [package|package.deb\fR
.SH "DESCRIPTION"
.\" Add any additional description here
.PP 
Select a manpage from a debian package for viewing with man or an alternative viewer. The list of manpages is displayed in a dialog. Supported locations for debian packages are: Local .deb\-file, a package in the repository or a installed package.
.TP 
\fB\-\-help\fR
display a small help and exit
.TP 
\fB\-m manpageviewer\fR
Optionally set a manpage viewer. The viewer must support .gz files. You must define the complete request. "%s" gets replaced with the path to the manpage. If "%s" is missing " %s" is appended to the manpageviewer. The manpageviewer must be enclosed with "" or '' \- see examples.
If you use a graphical viewer you must ensure that you have access to your desktop (if necessary: sux or ssh with x\-forwarding)
.TP 
\fB\-k\fR
Display the manpage using your preferred viewer (must support .gz files) if you use KDE \- this is the short form of \-m 'kfmclient exec man:%s'. "kfmclient" is a part of the package "konqueror".
.TP 
\fB\-g\fR
Display the manpage using your preferred viewer (must support .gz files) if you use GNOME \- this is the short form of \-m 'gnome\-open man:%s'. "gnome\-open" is a part of the package "libgnome2\-0".
.TP 
\fB\-x\fR
Display the manpage using your preferred viewer (must support .gz files) if you use KDE/GNOME/Xfce \- this is the short form of \-m 'xdg\-open man:%s'. "xdg\-open" is a part of the package "xdg\-utils".
.TP 
\fB\-L limit\fR
If a file which must be downloaded exceeds the limit, you are asked if the download should start. Without unit the value is in bytes. You can append K, M, G or T to the value to change the unit.
.TP 
\fB\-l lang1[,...]\fR
English manpages are displayed always. If you want more languages you can specify them here. Provide a comma separated list of the folder names in the manpgage folders (/usr/share/man,/usr/X11R6/man) \- e.g. de,fr or "*" if you want to see all languages. Folders with ".xyz" at the end (e.g. fr.ISO8859\-1) are automatically selected together with your choice (fr in this example).
.PP 
The manpages are temporarily extracted to /dev/shm (if the directory exists) or /tmp . You can override the path if you set and export the environment variable TMPDIR.
.PP 
You need to have the debian package "whiptail" (preferred) or "dialog" as well as "curl" installed.
.SH "EXAMPLES"
.TP 
debmany coreutils
Show all manpages from the installed debian package "coreutils" using man.
.TP 
debmany 3dchess
Show all manpages from the package "3dchess" using man. Since it is not already installed the package is accessed from the repository \- even downloading is done if needed. 
.TP 
debmany test.deb
Show all manpages from the local debian package "./test.deb" using man.
.TP 
debmany \-k sc
Use your preferred man\-viewer (for KDE user)
.TP 
debmany \-g sc
Use your preferred man\-viewer (for GNOME user)
.TP 
debmany \-x sc
Use your preferred man\-viewer (for KDE/GNOME/Xfce user)
.TP 
debmany \-m 'konqueror man:%s' sc
Use Konqueror as viewer
.TP 
alias debmany='debmany \-l de \-L 5M \-k'; debmany \-m man \-l "*" foo
Set an alias with your preferred options and overwrite them if needed.
.SH "AUTHOR"
Written by Michael Arlt.
.SH "LICENSE"
This is free software.  You may redistribute copies of it under the terms of
the GNU General Public License <http://www.gnu.org/licenses/gpl.html>.
There is NO WARRANTY, to the extent permitted by law.