aboutsummaryrefslogtreecommitdiffstats
path: root/fbi.man
diff options
context:
space:
mode:
authorStéphane Aulery <lkppo@free.fr>2012-01-27 00:22:41 +0100
committerGerd Hoffmann <kraxel@redhat.com>2012-01-27 12:18:38 +0100
commit1c89a4dd1cb65901ab561135415af681b3e0a6f2 (patch)
tree9a527cc716ebf8a78f7d2cd1be5e4e80fbaa7d48 /fbi.man
parent3d8b2d19bb25359c22fb05c3c8386a3bf3e1fdea (diff)
downloadfbida-1c89a4dd1cb65901ab561135415af681b3e0a6f2.tar.gz
Complete fbi manpage, add its french translation, and make consistant fbi help messages
fbi.c: * Fix copyright * Complete help message (webp format) et improve words wrap * Make message of "h" command consistant with fbi.man fbi.man: * .SH et .BR commands fix * Improve words wrap * Explicit "-d" argument * Add missing "a" command * Some typos * Reorder commands * Group author and copyright sections fbi.man.fr: * French translation of fbi.man
Diffstat (limited to 'fbi.man')
-rw-r--r--fbi.man179
1 files changed, 83 insertions, 96 deletions
diff --git a/fbi.man b/fbi.man
index 6facacf..5a807c3 100644
--- a/fbi.man
+++ b/fbi.man
@@ -10,17 +10,14 @@ fbi - Linux framebuffer imageviewer
\#
\#
.SH DESCRIPTION
-.BR fbi
-displays the specified file(s) on the linux console using the
-framebuffer device.
-\fIPhotoCD\fP, \fIjpeg\fP, \fIppm\fP, \fIgif\fP, \fItiff\fP, \fIxwd\fP,
-\fIbmp\fP, \fIpng\fP and \fIwebp\fP are supported directly.
-For other formats
+.BR Fbi
+displays the specified file(s) on the linux console using the framebuffer
+device. \fIPhotoCD\fP, \fIjpeg\fP, \fIppm\fP, \fIgif\fP, \fItiff\fP, \fIxwd\fP,
+\fIbmp\fP, \fIpng\fP and \fIwebp\fP formats are supported natively. For other
.BR fbi
tries to use
-.BR ImageMagick (1)
-\'s
-.BR convert (1).
+.BR "ImageMagick" "(1)\'s"
+.BR "convert" "(1)."
\#
\#
.SH OPTIONS
@@ -38,21 +35,18 @@ Write command line arguments to config file.
Read image filelist from \fIfile\fP.
.TP
.B -P, --text
-Enable textreading mode.
-This has the effect that
+Enable textreading mode. In this mode
.BR fbi
-will display large images without vertical offset (default is to center
-the images).
-Space will first try to scroll down and go to the next image only if it
-is already on the bottom of the page.
-Useful if the images you are watching text pages, all you have to do to
-get the next piece of text is to press space...
+will display large images without vertical offset (default is to center the
+images). The \fBSPACE\fP command will first try to scroll down and go to the
+next image only if it is already on the bottom of the page. Useful if the images
+you are watching are text pages, all you have to do to get the next piece of
+text is to press space...
.TP
.B -a, --autozoom
Enable autozoom.
.BR Fbi
-will automagically pick a reasonable zoom factor when loading a new
-image.
+will automagically pick a reasonable zoom factor when loading a new image.
.TP
.B --(no)autoup
Like autozoom, but scale up only.
@@ -70,11 +64,11 @@ Be verbose: enable status line on the bottom of the screen.
Randomize the order of the filenames.
.TP
.B --(no)comments
-Display comment tags (if present) instead of the filename.
-Probably only useful if you added reasonable comments yourself (using
-.BR wrjpgcom (1)
-for example), otherwise you likely just find texts pointing to the
-software which created the image.
+Display comment tags (if present) instead of the filename. Probably only useful
+if you added reasonable comments yourself (using
+.BR "wrjpgcom" "(1)"
+for example), otherwise you likely just find texts pointing to the software
+which created the image.
.TP
.B -e, --(no)edit
Enable editing commands.
@@ -94,8 +88,8 @@ Image cache \fIsize\fP in megabytes (MB).
.BI "--blend" "\ time"
Image blend \fItime\fP in miliseconds.
.TP
-.BI "-T" "\ <arg>" ", --vt" "\ <arg>
-Start on virtual console \fI<arg>\fP.
+.BI "-T" "\ n" ", --vt" "\ n"
+Start on virtual console \fIn\fP.
.TP
.BI "-s" "\ steps" ", --scroll" "\ steps"
Set scroll \fIsteps\fP in pixels (default is 50).
@@ -114,24 +108,22 @@ Gamma correction. Default is 1.0. Requires \fIPseudocolor\fP or
\fIDirectcolor\fP visual, doesn't work for \fITruecolor\fP.
.TP
.BI "-f" "\ <arg>" ", --font" "\ <arg>"
-Set font. This can be anything fontconfig accepts (see
-.BR fonts-conf (5)
-). Try
-.BR fc-list (1)
-for a list of known fonts on your system.
-The fontconfig config file is evaluated as well, so any generic stuff
-defined there (such as mono, sans) will work as well.
-It is recommended to use monospaced fonts, the textboxes (help text,
-exif info) look better then.
-.TP
-.BI "-d" "\ fbdevice" ", --device" "\ fbdevice"
-Use \fIfbdevice\fP framebuffer.
-Default is the one your vc is mapped to.
+Set font. This \fI<arg>\fP can be anything fontconfig accepts (see
+.BR "fonts\-conf" "(5))."
+Try
+.BR "fc\-list" "(1)"
+for a list of known fonts on your system. The fontconfig config file is
+evaluated as well, so any generic stuff defined there (such as mono, sans) will
+work as well. It is recommended to use monospaced fonts, the textboxes (help
+text, exif info) look better then.
+.TP
+.BI "-d" "\ /dev/fbN" ", --device" "\ /dev/fbN"
+Use \fI/dev/fbN\fP device framebuffer. Default is the one your virtual console
+is mapped to.
.TP
.BI "-m" "\ videomode" ", --mode" "\ videomode"
Name of the video mode to use (video mode must be listed in
-\fI/etc/fb.modes\fP).
-Default is not to change the video mode.
+\fI/etc/fb.modes\fP). Default is not to change the video mode.
\#
\#
.SH ENVIRONMENT
@@ -143,8 +135,8 @@ This variable may be used to specify a default gamma correction.
\#
\#
.SH "COMMAND USAGE"
-The commands take effect immediately; it is not necessary to type a
-carriage return.
+The commands take effect immediately; it is not necessary to type a carriage
+return.
.PP
In the following commands, \fIi\fP is a numerical argument.
.SS Scrolling
@@ -158,20 +150,16 @@ Previous image.
\fBNEXT_SCREEN\fP, \fBSPACE\fP, \fBj\fP
Next image.
.TP
-\fBRETURN\fP
-Write the filename of the current image to
-.BR stdout (3)
-, then go to the next image.
-.TP
\fIi\fP\fBg\fP
Jump to image #\fIi\fP.
.TP
-\fBp\fP
-Pause the slideshow (if started with \fB-t\fP, toggle).
+\fBRETURN\fP
+Write the filename of the current image to
+.BR "stdout" "(3),"
+then go to the next image.
.P
-The \fBRETURN\fP vs. \fBSPACE\fP key thing can be used to create a file
-list while reviewing the images and use the list for batch processing
-later on:
+The \fBRETURN\fP vs. \fBSPACE\fP key thing can be used to create a file list
+while reviewing the images and use the list for batch processing later on:
.P
.in +4n
\fIfbi\ file1.gif\ file2.jpg\ file3.jpg >\ fileimagelist.lst\fP
@@ -185,6 +173,9 @@ some \fBRETURN\fP and \fBSPACE\fP...
.in
.SS Zoom
.TP
+\fBa\fP
+Autozoom.
+.TP
\fB+\fP
In.
.TP
@@ -205,15 +196,18 @@ Toggle status line.
Display textbox with brief help.
.TP
\fBi\fP
-Display textbox with some EXIF \fIEXIF\fP info.
+Display textbox with some \fIEXIF\fP info.
+.TP
+\fBp\fP
+Pause the slideshow (if started with \fB-t\fP, toggle).
.SS Edit mode
.BR Fbi
-also provides some very basic image editing facilities.
-You have to start
+also provides some very basic image editing facilities. You have to
+start
.BR fbi
with the \fI-e\fP switch to use them.
.TP
-\fBD\fP
+\fBD\fP, \fBShift+d\fP
Delete image.
.TP
\fBr\fP
@@ -222,46 +216,35 @@ Rotate 90 degrees clockwise.
\fBl\fP
Rotate 90 degrees counter-clock wise.
.P
-The delete function actually wants a capital letter 'D', thus you have
-to type \fBShift+d\fP.
-This is done to avoid deleting images by mistake because there are no
-safety bells:
-If you ask fbi to delete the image, it will be deleted without questions
-asked.
+The delete function actually wants a capital letter \fBD\fP, thus you have to type
+\fBShift+d\fP. This is done to avoid deleting images by mistake because there
+are no safety bells: If you ask
+.BR fbi
+to delete the image, it will be deleted without questions asked.
.P
-The rotate function actually works for \fIJPEG\fP images only.
-It does a lossless transformation of the image.
+The rotate function actually works for \fIJPEG\fP images only. It does a
+lossless transformation of the image.
\#
\#
.SH BUGS
.BR Fbi
-needs rw access to the framebuffer devices (\fI/dev/fbN\fP), i.e you (our
-your admin) have to make sure
+needs rw access to the framebuffer devices (\fI/dev/fbN\fP), i.e you (our your
+admin) have to make sure
.BR fbi
-can open the devices in rw mode.
-The IMHO most elegant way is to use
+can open the devices in rw mode. The IMHO most elegant way is to use
.BR PAM (7)
-to chown the devices to the user
-logged in on the console.
-Another way is to create some group, chown the special files to that
-group and put the users which are allowed to use the framebuffer device
-into the group.
-You can also make the special files world writable, but be aware of the
-security implications this has.
-On a private box it might be fine to handle it this way though.
+to chown the devices to the user logged in on the console. Another way is to
+create some group, chown the special files to that group and put the users which
+are allowed to use the framebuffer device into the group. You can also make the
+special files world writable, but be aware of the security implications this
+has. On a private box it might be fine to handle it this way though.
.P
.BR Fbi
-also needs access to the linux console (\fI/dev/ttyN\fP) for sane
-console switch handling.
-That is obviously no problem for console logins, but any kind of a
+also needs access to the linux console (\fI/dev/ttyN\fP) for sane console switch
+handling. That is obviously no problem for console logins, but any kind of a
pseudo tty (xterm, ssh, screen, ...) will \fBnot\fP work.
\#
\#
-.SH AUTHOR
-Gerd Knorr
-.BR <kraxel@bytesex.org>
-\#
-\#
.SH "SEE ALSO"
.BR convert (1),
.BR fbset (1),
@@ -272,19 +255,23 @@ Gerd Knorr
.BR PAM (7)
\#
\#
+.SH AUTHOR
+Gerd Knorr
+.BR <kraxel@bytesex.org>
+\#
+\#
.SH COPYRIGHT
Copyright (c) 1999-2012 Gerd Knorr <kraxel@bytesex.org>
.P
-This program is free software; you can 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 of the License, or
-(at your option) any later version.
+This program is free software; you can 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 of the License, or (at your option) any later
+version.
.P
-This program 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.
+This program 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.
.P
-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., 675 Mass Ave, Cambridge, MA 02139, USA.
+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., 675 Mass Ave,
+Cambridge, MA 02139, USA.