[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#286456: advi: Man page inconsistencies and minor formatting problems



Package: advi
Version: 1.6.0-3
Severity: minor
Tags: patch

Some minor problems with the man page:
a) Other programs are usually refered to as name(1). Fixed in patch
b) In english, the column is usually not prefixed with a space. Since
   this occurs in other files of the distribution, not fixed. (But
   note: in the man page both conventions are used, so you should
   consider unifying them)
c) Some phrases sound a little awkward to me, e.g.,
   execute an action when the mouse is over
   Since I am not a native speaker, not fixed. Some other I could not
   even understand really, e.g.,
   Display thumbnails if processed or floating table of contents, or
   do nothing.
   Maybe consider asking on debian-i18n-english for proofreading?
d) The file format DVI is always capitalized, but others are not
   (which are also abbreviations), fixed.
e) Several defaults are set to non-free programms
   (netscape-communicator, xv) according to the man page. This is not
   strictly a documentation bug, but I am too lazy right now to check
   (please ask me, then I can check). If these programms are indeed
   used as default, Debian should consider changing them to available
   free programms; please clone with severity wishlist then.
f) Filenames should be printed in italics. 
g) I unified (hopefully I did not miss one) the usage of full stops
   within itemimization. In the first itemization almost all had no
   full stop, there I removed the ones too much, in the second it was
   reversed, hence I added the full stops. You might consider using
   the same style in both itemizations, though.
h) Unified spelling of Active\-DVI
i) In the comments at the beginning, the source for documentation (man
   7 man) is specified. I could not find an .UR nfroff macro, and the
   URLs in the SEE ALSO section were not printed. The "workaround" is
   using .mso www.tmac in the beginning and .URL instead of .UR. Since
   listing in english usually requires and "," before the "and", I
   used the arguments of .URL (which also should improve if the man
   page is converted to HTML, see man (7) man for details)
j) The manual in the SEE ALSO section was formatted using .BR. Since
   it is not a program, I remove that. If there was a reason for the
   alternating bold/roman, you might consider protecting the spaces at
   least (because .BR ignores them).
k) I think there should be "," in the AUTHORS section between authors,
   and I would replace the "," present by ";" to seperate the author
   groups. This is of course also a question of taste, hence not
   changed.
l) I commented out the (fixed, see above) .URL in the NAME section,
   because with it the line well exceeds 80 characters. Even without,
   it is too long (but better). 
M) In the keystroke some strokes (used in explanation) are explicitliy
   quoted via ` and ', while most are set with .B. Not changed.
N) The name LUTHER is the only one completely capitalized. This should
   probably be unified? Not changed.
O) Some other small fixes, e.g., spelling


--- advi.1.orig	2004-10-02 23:37:34.000000000 +0200
+++ advi.1	2004-12-19 21:37:38.227961264 +0100
@@ -15,11 +15,11 @@
 .\" .br        insert line break
 .\" .sp <n>    insert n+1 empty lines
 .\" for manpage-specific macros, see man(7)
+.mso www.tmac
 .SH NAME
 .B advi
 \-\- a DVI previewer and presenter
-.UR http://caml.inria.fr/advi/
-(http://caml.inria.fr/advi/)
+.\" .URL http://caml.inria.fr/advi/ http://caml.inria.fr/advi/
 .UE
 with some eye candy effects for presentation.
 
@@ -34,7 +34,9 @@
 program is a viewer for DVI files that also recognizes a new class of
 special's targeted to presentations via laptop computers: various
 visual effects can easily be incorporated to the presentation, via a
-companion advi.sty LaTeX package.
+companion 
+.I advi.sty
+LaTeX package.
 
 .P
 .B advi
@@ -55,9 +57,13 @@
 
 \- Embedded applications for interactive demonstration
 
-\- Pictures visualization via gpic specials
+\- Pictures visualization via
+.BR gpic (1)
+specials
+
+\- Display of inlined Postscript using 
+.BR gs (1)
 
-\- Display of inlined Postscript using gs
 
 \- Font antialiasing that takes background colors into account
 
@@ -96,7 +102,9 @@
 
 Notice that
 .B advi
-needs the `kpsewhich' tool in order to find and
+needs the 
+.BR kpsewhich (1) 
+tool in order to find and
 recompile PK fonts.  (This program is part of the `kpathsea' library
 provided by many TeX distributions.)
 
@@ -113,7 +121,9 @@
 Ignore background for antialiasing
 .TP
 .B \-\-showps
-Print a copy of Postscript sent to gs to stdout
+Print a copy of Postscript sent to 
+.BR gs (1)
+to stdout
 .TP
 .B \-\-verbose\-image\-access
 Change the cursor while loading images
@@ -138,7 +148,8 @@
 Command to call the browser (default netscape\-communicator)
 .TP
 .B \-cache\-dir STRING
-Set the cache directory (default /tmp)
+Set the cache directory (default
+.IR /tmp )
 .TP
 .B \-click\-turn
 Turn pages with mouse clicks (see the doc)
@@ -147,7 +158,7 @@
 Crop the window to the best size (default)
 .TP
 .B \-disable\-image\-anti\-aliasing
-Disable eps inclusion anti\-aliasing
+Disable EPS inclusion anti\-aliasing
 .TP
 .B \-edit
 Start in edit mode
@@ -162,7 +173,8 @@
 Set default foreground color (Named or RGB)
 .TP
 .B \-film\-viewer STRING
-Command to display film files (default mplayer)
+Command to display film files (default 
+.BR mplayer (1))
 .TP
 .B \-fullwidth
 Adjust size to width
@@ -182,7 +194,7 @@
 .B \-html STRING
 Make
 .B advi
-start at html reference of name STRING
+start at HTML reference of name STRING
 .TP
 .B \-image\-viewer STRING
 Command to display image files (default xv)
@@ -216,7 +228,11 @@
 .TP
 .B \-options\-file STRING
 Load this file when parsing this option to set up options
-(to override the options of the default ~/.advirc or ~/.advi/advirc init file).
+(to override the options of the default 
+.I ~/.advirc 
+or 
+.I ~/.advi/advirc
+init file)
 .TP
 .B \-page INT
 Make
@@ -232,7 +248,7 @@
 Set the name of the file where
 .B advi
 could write the current page number
-(default is file 'advi\_page\_number' in the cache directory).
+(default is file 'advi\_page\_number' in the cache directory)
 .TP
 .B \-pager STRING
 Command to call the pager (default xterm \-e less)
@@ -241,19 +257,21 @@
 Cancel all Active\-DVI effects
 .TP
 .B \-pdf\-viewer STRING
-Command to view PDF files (default xpdf)
+Command to view PDF files (default 
+.BR xpdf (1))
 .TP
 .B \-ps\-viewer STRING
-Command to view PS files (default gv)
+Command to view PS files (default
+.BR gv (1))
 .TP
 .B \-pstricks
 Show moveto
 .TP
 .B \-resolution REAL
-Dpi resolution of the screen (min 72.27)))
+DPI resolution of the screen (min. 72.27)))
 .TP
 .B \-rv
-Reverse video is simulated by swapping the foreground and background colors.
+Reverse video is simulated by swapping the foreground and background colors
 .TP
 .B \-safer
  Safer mode: external applications are never launched
@@ -277,10 +295,10 @@
 Set the number of thumbname per line and column to INT
 .TP
 .B \-thumbnails
-Create thumbnails for your slides and write them into cachedir.
+Create thumbnails for your slides and write them into cachedir
 .TP
 .B \-thumbnails\-size STRING
-Fix thumbnails size (default 24x32).
+Fix thumbnails size (default 24x32)
 .TP
 .B \-v
 Print the current Active\-DVI version
@@ -302,7 +320,7 @@
 
 .P
 Geometry GEOM is specified in pixels, using the standard format
-for specifying geometries (i.e: "WIDTHxHEIGHT[+XOFFSET+YOFFSET]").
+for specifying geometries (i.e.,  "WIDTHxHEIGHT[+XOFFSET+YOFFSET]").
 
 Dimensions (for options `-hmargin' and `-vmargin') are specified as
 numbers optionally followed by two letters representing units.
@@ -326,41 +344,41 @@
 Advi recognizes the following keystrokes when typed in its window.
 Some of them may optionally be preceded by a number, called ARG below,
 whose interpretation is keystroke dependant. If ARG is unset, its
-value is 1, unless specified otherwise.
+value is 1.
 
 Advi maintains an history of previously visited pages organized as a stack.
-Additionnally, the history contains mark pages which are stronger than
+Additionally, the history contains mark pages which are stronger than
 unmarked pages.
 
 .RS 2
 .TP 8
 .B ?
-Quick info and key bindings help
+Quick info and key bindings help.
 
 .TP
 .B q
-Quits the program
+Quits the program.
 
 .TP
 .B ^X\-^C (Control\-X Control\-C)
-Quits the program
+Quits the program.
 
 .TP
 .B ^X\-^F (Control\-X Control\-F)
-Turn to full screen mode
+Turn to full screen mode.
 
 .TP
 .B ^F (Control\-F)
-Toggle to switch from full screen to normal mode and converse
+Toggle to switch from full screen to normal mode and converse.
 
 .TP
 .B ^<button> (Control + left mouse button)
-Allow moving the page into the window (useful in full screen mode)
+Allow moving the page into the window (useful in full screen mode).
 
 .TP
 .B return
 If ARG is non zero, push the current page on the history stack, and move
-forward Arg physical pages.
+forward ARG physical pages.
 
 .TP
 .B n
@@ -381,7 +399,7 @@
 .TP
 .B <backspace>
 Move ARG pages backward according to the history.
-The history stack is poped, accordingly.
+The history stack is popped, accordingly.
 
 .TP
 .B <escape>
@@ -409,11 +427,11 @@
 
 .TP
 .B <
-Scale the resolution by 1/scalestep (default 1/sqrt (sqrt (sqrt 2.0)))
+Scale the resolution by 1/scalestep (default 1/sqrt (sqrt (sqrt 2.0))).
 
 .TP
 .B >
-Scale the resolution by  scalestep (default sqrt (sqrt (sqrt 2.0)))
+Scale the resolution by  scalestep (default sqrt (sqrt (sqrt 2.0))).
 
 .TP
 .B f
@@ -436,34 +454,34 @@
 
 .TP
 .B C
-Erase the image cache
+Erase the image cache.
 
 .TP
 .B T
-Process thumbnails (graphical table of contents for the show)
+Process thumbnails (graphical table of contents for the show).
 
 .TP
 .B t
 Display thumbnails if processed or floating table of contents, or do
-nothing
+nothing.
 
 .TP
 .B ^X\-l (Control\-X l)
-Toggle on or off the laser pointer
+Toggle on or off the laser pointer.
 
 .TP
 .B s
 Turn on the write scratching mode (to interactively write on the
 slide). When in scratching mode press
 .B ? 
-to get help
+to get help.
 
 .TP
 .B S
 Turn on the draw scratching mode (to interactively draw on the
 slide). When in scratching mode press
 .B ? 
-to get help
+to get help.
 
 .TP
 .B ^X\-^S (Control\-X Control\-S)
@@ -489,19 +507,24 @@
 
 .SH EYE CANDY MACROS
 
-Using the LaTeX style advi.sty provided with the package, you can
-embed some Active dvi specials into your TeX documents.
+Using the LaTeX style
+.I advi.sty
+provided with the package, you can
+embed some Active\-DVI specials into your TeX documents.
 .B Advi
 interprets those specials to provide some eye candy features for your
-presentation. For the casual user, the advi\-slides.sty package gives
-a truely simple way to write a show for
+presentation. For the casual user, the 
+.I advi\-slides.sty
+package gives
+a truly simple way to write a show for
 .B advi
 (see in the examples directory or the documentation inside the
-advi\-slides.sty file for more information).
+.I advi\-slides.sty
+file for more information).
 
 .TP
 .B \eadviwait
-ActiveDvi stops rendering at the point of the document and wait a user key
+Active\-DVI stops rendering at the point of the document and wait a user key
 stroke.
 
 .TP
@@ -529,7 +552,11 @@
 
 .RE
 The directory examples contains a lot of presentations.
-Please look also at test/demo*.{tex|dvi} and test/macros.{tex|dvi} for
+Please look also at 
+.I test/demo*.{tex|dvi}
+and 
+.I test/macros.{tex|dvi}
+for
 a rather comprehensive demonstration of Active\-DVI capabilities.
 
 .SH COPYRIGHT
@@ -537,22 +564,25 @@
 .SH SEE ALSO
 .BR latex (1),
 .BR kpsewhich (1),
-.BR The Active-DVI user's manual
-.UR http://caml.inria.fr/advi/manual.dvi
-and the FAQ
-.UR http://caml.inria.fr/advi/faq.html
+the Active\-DVI user's 
+.URL http://caml.inria.fr/advi/manual.dvi manual ,
+and the 
+.URL http://caml.inria.fr/advi/faq.html FAQ
 .SH AUTHORS
 Jun Furuse <Jun.Furuse@inria.fr>
 Pierre Weis <Pierre.Weis@inria.fr>
-Didier Remy <Didier.Remy@inria.fr> inlined Postcript, hyperlinks
+Didier Remy <Didier.Remy@inria.fr> inlined Postscript, hyperlinks
 Roberto Di Cosmo <dicosmo@pauillac.inria.fr>
-Xavier Leroy <Xavier.Leroy@inria.fr> gpic specials
+Xavier Leroy <Xavier.Leroy@inria.fr> 
+.BR gpic (1)
+specials
 Didier Le Botlan <Didier.Le_Botlan@inria.fr>
 Alan Schmitt <Alan.Schmitt@inria.fr>
 Alexandre Miquel  <Alexandre.Miquel@inria.fr>
 .P
 The original version of this manual page was written by Sven LUTHER
-<luther@debian.org>, for the Debian GNU/Linux system port of advi
+<luther@debian.org>, for the Debian GNU/Linux system port of 
+.B advi
 version 1.2.  This page has then been enhanced and updated for later
-versions of Active-DVI, and finally rewritten for version 1.6 by
+versions of Active\-DVI, and finally rewritten for version 1.6 by
 Pierre Weis.

-- System Information:
Debian Release: 3.1
  APT prefers testing
  APT policy: (500, 'testing')
Architecture: powerpc (ppc)
Kernel: Linux 2.6.8
Locale: LANG=de_DE@euro, LC_CTYPE=de_DE@euro (charmap=ISO-8859-15)

Versions of packages advi depends on:
ii  gs                        8.01-5         Transitional package
ii  gs-gpl [gs]               8.01-5         The GPL Ghostscript PostScript int
ii  libc6                     2.3.2.ds1-18   GNU C Library: Shared libraries an
ii  libfreetype6              2.1.7-2.3      FreeType 2 font engine, shared lib
ii  libice6                   4.3.0.dfsg.1-8 Inter-Client Exchange library
ii  libjpeg62                 6b-9           The Independent JPEG Group's JPEG 
ii  libpng12-0                1.2.8rel-1     PNG library - runtime
ii  libsm6                    4.3.0.dfsg.1-8 X Window System Session Management
ii  libtiff4                  3.6.1-3        Tag Image File Format library
ii  libungif4g                4.1.3-1        shared library for GIF images (run
ii  libx11-6                  4.3.0.dfsg.1-8 X Window System protocol client li
ii  libxext6                  4.3.0.dfsg.1-8 X Window System miscellaneous exte
ii  libxpm4                   4.3.0.dfsg.1-8 X pixmap library
ii  tetex-bin                 2.0.2-23       The teTeX binary files
ii  xlibs                     4.3.0.dfsg.1-8 X Window System client libraries m
ii  zlib1g                    1:1.2.2-3      compression library - runtime

-- no debconf information
-- 
Helge Kreutzmann, Dipl.-Phys.               Helge.Kreutzmann@itp.uni-hannover.de
                       gpg signed mail preferred 
    64bit GNU powered                  http://www.itp.uni-hannover.de/~kreutzm
       Help keep free software "libre": http://www.freepatents.org/

Attachment: pgpDP0qnnEmho.pgp
Description: PGP signature


Reply to: