[PATCH] Fixing warnings in manpages

Fabian Greffrath <[email protected]> Mon, 24 Mar 2008 14:42:43 +0100

Newsgroups	gmane.comp.video.mjpeg.devel
Message-ID	<1206366163.4798.6.camel@beppo>

Dear mjpegtools developers,

man's --warning option throws some warnings in some of the installed
manpages. Indeed some of them look badly formatted (e.g. the MJPEG HOWTO
manpage is misformatted). The attached patch does not fix all of the
issues but at least keeps man from throwing out warnings.

Cheers,
Fabian

-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/

_______________________________________________
Mjpeg-developer mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/mjpeg-developer

mjpegtools-1.9~rc3_manpage-syntax.patch (text/x-patch, 4.3 KB)

diff -Nur mjpegtools-1.9.0rc3/docs/lavplay.1 mjpegtools-1.9.0rc3.new/docs/lavplay.1
--- mjpegtools-1.9.0rc3/docs/lavplay.1
+++ mjpegtools-1.9.0rc3.new/docs/lavplay.1
@@ -26,7 +26,7 @@
 .TP 8
 .BR \-p/\-\-playback " [" S | C | H ]
 The playback mode to be used. 'S' means software\-playback using SDL.
-'H' means hardware\-playback on the monitor (on\-screen). 'C' means
+ 'H' means hardware\-playback on the monitor (on\-screen). 'C' means
 hardware\-playback to the video-out of the zoran video-capture device.
 Obviously, 'C' and 'H' only work on computers with zoran video\-capture
 devices.
diff -Nur mjpegtools-1.9.0rc3/docs/mjpeg-howto.info mjpegtools-1.9.0rc3.new/docs/mjpeg-howto.info
--- mjpegtools-1.9.0rc3/docs/mjpeg-howto.info
+++ mjpegtools-1.9.0rc3.new/docs/mjpeg-howto.info
@@ -1,3 +1,4 @@
+INFO-DIR-SECTION Video
 START-INFO-DIR-ENTRY
 * mjpegtools: (mjpeg-howto).       command line tools for MPEG audio and video.
 END-INFO-DIR-ENTRY
diff -Nur mjpegtools-1.9.0rc3/docs/mjpegtools.1 mjpegtools-1.9.0rc3.new/docs/mjpegtools.1
--- mjpegtools-1.9.0rc3/docs/mjpegtools.1
+++ mjpegtools-1.9.0rc3.new/docs/mjpegtools.1
@@ -1,8 +1,8 @@
-.\"
-.TH "MJPEG tools" "MJPEG Linux Square" "MJPEG tools manual"
+.TH "MJPEG tools" "1" "MJPEG Linux Square" "MJPEG tools manual"
 .LP
 
-MJPEG HOWTO - An introduction to the MJPEG-toolsPraschinger Bernhardv1.50MJPEG capture/editting/replay and MPEG encoding toolset description
+.SH "NAME"
+mjpegtools \- An introduction to the MJPEG-tools
 .PP
 Introduction
 
@@ -94,7 +94,6 @@
 .PP
 One last thing about the data you get before we start:
 .PP
-.DS
 .sp 
 .ft RR
 .nf
@@ -108,7 +107,6 @@
 PAL FULL size : (720 * 576 * 25 * 80) / (200 * 1024) = 4050 kB/sec
 NTSC HALF size: (352 * 240 * 30 * 80) / (200 * 1024) = 990 kB/sec
 NTSC FULL size: (720 * 480 * 30 * 80) / (200 * 1024) = 4050 kB/sec
-.DE
 .fi 
 .ec
 .ft P
@@ -447,7 +445,6 @@
 .nr el +1
 .nr t\n(ll 1
 .nr e\n(el 0 1
-.af e\n(el \*(f\n(el
 .if \n(ll>1 .RS
 .nr bi 1
 .PP
@@ -489,7 +486,6 @@
 .nr el +1
 .nr t\n(ll 1
 .nr e\n(el 0 1
-.af e\n(el \*(f\n(el
 .if \n(ll>1 .RS
 .nr bi 1
 .PP
@@ -535,7 +531,6 @@
 .nr el +1
 .nr t\n(ll 1
 .nr e\n(el 0 1
-.af e\n(el \*(f\n(el
 .if \n(ll>1 .RS
 .nr bi 1
 .PP
@@ -565,7 +560,6 @@
 have, you need to extract some frames from the recorded stream and take a
 look at them:\fP
 .PP
-.DS
 .sp 
 .ft RR
 .nf
@@ -574,7 +568,6 @@
 > rm pnm/image?.pnm 
 > cd pnm 
 > xv 
-.DE
 .fi 
 .ec
 .ft P
@@ -1078,7 +1071,6 @@
 The resulting video can be written as a LAV Edit List, a plain text file
 containing the following lines:
 .PP
-.DS
 .sp 
 .ft RR
 .nf
@@ -1091,7 +1083,6 @@
 0 0 224
 1 0 24
 2 25 999
-.DE
 .fi 
 .ec
 .ft P
@@ -1623,7 +1614,6 @@
 maximal bitrate is not set too low:
 .PP
 
-.DS
 .sp 
 .ft RR
 .nf
@@ -1632,7 +1622,6 @@
    q >= 10 average quality
    q >= 11 not that good
    q >= 13 here even still sequences might look blocky
-.DE
 .fi 
 .ec
 .ft P
@@ -1843,12 +1832,10 @@
 .PP
 The approximate frame length formula for MPEG-1 layer-II is:
 .PP
-.DS
 .sp 
 .ft RR
 .nf
 (frame length in bytes) = 144 * (byte rate) / (sample rate)
-.DE
 .fi 
 .ec
 .ft P
@@ -2736,14 +2723,12 @@
 .PP
 You should get something like this:
 .PP
-.DS
 .sp 
 .ft RR
 .nf
 Found stream id 0xE0 = Video Stream 0
 Found stream id 0xC0 = MPEG Audio Stream 0
 Found stream id 0xBE = Padding Stream
-.DE
 .fi 
 .ec
 .ft P
diff -Nur mjpegtools-1.9.0rc3/docs/mpeg2enc.1 mjpegtools-1.9.0rc3.new/docs/mpeg2enc.1
--- mjpegtools-1.9.0rc3/docs/mpeg2enc.1
+++ mjpegtools-1.9.0rc3.new/docs/mpeg2enc.1
@@ -222,7 +222,8 @@
 Set verbosity level to num.  0 = warnings and errors only, 1 =
 information as well, 2=really verbose.
 .PP
-.BR -K|--custom-quant-matrices \fBkvcd\fP | \fBtmpgenc\fP | \fBdefault\fP | \fBhi-res\fP | \fBfile=\fPinputfile | \fBhelp\fP
+.BR -K|--custom-quant-matrices \fBkvcd\fP | \fBtmpgenc\fP |
+ \fBdefault\fP | \fBhi-res\fP | \fBfile=\fPinputfile | \fBhelp\fP
 .PP
 Specify which quantisation matrices to use instead of the defaults
 (which can be specified by using "-K default").   Using "-K hi-res" is
diff -Nur mjpegtools-1.9.0rc3/docs/mplex.1 mjpegtools-1.9.0rc3.new/docs/mplex.1
--- mjpegtools-1.9.0rc3/docs/mplex.1
+++ mjpegtools-1.9.0rc3.new/docs/mplex.1
@@ -129,7 +129,7 @@
 .br
 [,
 .I samples_per_sec:channels:bits_per_sample
-...]
+ ...]
 .br
 A comma-seperated list of paramter sets for the lpcm audio streams
 (given in the order the lpcm streams appear on the command line).