summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2012-12-16 20:53:16 +0100
committerStefano Sabatini <stefasab@gmail.com>2012-12-19 09:33:44 +0100
commit9d6517aa674bbee3d4014da87a642133f82f9b4d (patch)
tree5737baad29e738c258bc8630c64edc4003f9dda0
parentc2ac6477106a523984a3c8c8694c3f360ef9f41c (diff)
doc: extend "See Also" chapter rendering for ff* tools
Add more references, and generate alternative variants for HTML and POD output. In particular, this allows to render a "See Also" chapter in the HTML output.
-rw-r--r--doc/ffmpeg.texi26
-rw-r--r--doc/ffplay.texi26
-rw-r--r--doc/ffprobe.texi26
-rw-r--r--doc/ffserver.texi29
4 files changed, 89 insertions, 18 deletions
diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index 77ac10d720..825780f693 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -1289,6 +1289,28 @@ ffmpeg -i src.ext -lmax 21*QP2LAMBDA dst.ext
@include filters.texi
@include metadata.texi
+@chapter See Also
+
+@ifhtml
+@url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
+@url{ffmpeg-utils.html,ffmpeg-utils},
+@url{ffmpeg-scaler.html,ffmpeg-scaler},
+@url{ffmpeg-resampler.html,ffmpeg-resampler},
+@url{ffmpeg-codecs.html,ffmpeg-codecs},
+@url{ffmpeg-bitstream-filters,ffmpeg-bitstream-filters},
+@url{ffmpeg-formats.html,ffmpeg-formats},
+@url{ffmpeg-devices.html,ffmpeg-devices},
+@url{ffmpeg-protocols.html,ffmpeg-protocols},
+@url{ffmpeg-filters.html,ffmpeg-filters}
+@end ifhtml
+
+@ifnothtml
+ffplay(1), ffprobe(1), ffserver(1),
+ffmpeg-utils(1), ffmpeg-scaler(1), ffmpeg-resampler(1),
+ffmpeg-codecs(1), ffmpeg-bitstream-filters(1), ffmpeg-formats(1),
+ffmpeg-devices(1), ffmpeg-protocols(1), ffmpeg-filters(1)
+@end ifnothtml
+
@include authors.texi
@ignore
@@ -1296,10 +1318,6 @@ ffmpeg -i src.ext -lmax 21*QP2LAMBDA dst.ext
@setfilename ffmpeg
@settitle ffmpeg video converter
-@c man begin SEEALSO
-ffplay(1), ffprobe(1), ffserver(1) and the FFmpeg HTML documentation
-@c man end
-
@end ignore
@bye
diff --git a/doc/ffplay.texi b/doc/ffplay.texi
index 0a45a65e1d..29b2fc784f 100644
--- a/doc/ffplay.texi
+++ b/doc/ffplay.texi
@@ -196,6 +196,28 @@ Seek to percentage in file corresponding to fraction of width.
@include protocols.texi
@include filters.texi
+@chapter See Also
+
+@ifhtml
+@url{ffmpeg.html,ffmpeg}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
+@url{ffmpeg-utils.html,ffmpeg-utils},
+@url{ffmpeg-scaler.html,ffmpeg-scaler},
+@url{ffmpeg-resampler.html,ffmpeg-resampler},
+@url{ffmpeg-codecs.html,ffmpeg-codecs},
+@url{ffmpeg-bitstream-filters,ffmpeg-bitstream-filters},
+@url{ffmpeg-formats.html,ffmpeg-formats},
+@url{ffmpeg-devices.html,ffmpeg-devices},
+@url{ffmpeg-protocols.html,ffmpeg-protocols},
+@url{ffmpeg-filters.html,ffmpeg-filters}
+@end ifhtml
+
+@ifnothtml
+ffmpeg(1), ffprobe(1), ffserver(1),
+ffmpeg-utils(1), ffmpeg-scaler(1), ffmpeg-resampler(1),
+ffmpeg-codecs(1), ffmpeg-bitstream-filters(1), ffmpeg-formats(1),
+ffmpeg-devices(1), ffmpeg-protocols(1), ffmpeg-filters(1)
+@end ifnothtml
+
@include authors.texi
@ignore
@@ -203,10 +225,6 @@ Seek to percentage in file corresponding to fraction of width.
@setfilename ffplay
@settitle FFplay media player
-@c man begin SEEALSO
-ffmpeg(1), ffprobe(1), ffserver(1) and the FFmpeg HTML documentation
-@c man end
-
@end ignore
@bye
diff --git a/doc/ffprobe.texi b/doc/ffprobe.texi
index ba120d8b2a..9b941a33bb 100644
--- a/doc/ffprobe.texi
+++ b/doc/ffprobe.texi
@@ -493,6 +493,28 @@ DV, GXF and AVI timecodes are available in format metadata
@include protocols.texi
@include indevs.texi
+@chapter See Also
+
+@ifhtml
+@url{ffplay.html,ffmpeg}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
+@url{ffmpeg-utils.html,ffmpeg-utils},
+@url{ffmpeg-scaler.html,ffmpeg-scaler},
+@url{ffmpeg-resampler.html,ffmpeg-resampler},
+@url{ffmpeg-codecs.html,ffmpeg-codecs},
+@url{ffmpeg-bitstream-filters,ffmpeg-bitstream-filters},
+@url{ffmpeg-formats.html,ffmpeg-formats},
+@url{ffmpeg-devices.html,ffmpeg-devices},
+@url{ffmpeg-protocols.html,ffmpeg-protocols},
+@url{ffmpeg-filters.html,ffmpeg-filters}
+@end ifhtml
+
+@ifnothtml
+ffmpeg(1), ffplay(1), ffserver(1),
+ffmpeg-utils(1), ffmpeg-scaler(1), ffmpeg-resampler(1),
+ffmpeg-codecs(1), ffmpeg-bitstream-filters(1), ffmpeg-formats(1),
+ffmpeg-devices(1), ffmpeg-protocols(1), ffmpeg-filters(1)
+@end ifnothtml
+
@include authors.texi
@ignore
@@ -500,10 +522,6 @@ DV, GXF and AVI timecodes are available in format metadata
@setfilename ffprobe
@settitle ffprobe media prober
-@c man begin SEEALSO
-ffmpeg(1), ffplay(1), ffserver(1) and the FFmpeg HTML documentation
-@c man end
-
@end ignore
@bye
diff --git a/doc/ffserver.texi b/doc/ffserver.texi
index 3004d85894..4b000f7a26 100644
--- a/doc/ffserver.texi
+++ b/doc/ffserver.texi
@@ -260,6 +260,29 @@ messages to stdout.
@end table
@c man end
+@chapter See Also
+
+@ifhtml
+The @file{doc/ffserver.conf} example,
+@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe},
+@url{ffmpeg-utils.html,ffmpeg-utils},
+@url{ffmpeg-scaler.html,ffmpeg-scaler},
+@url{ffmpeg-resampler.html,ffmpeg-resampler},
+@url{ffmpeg-codecs.html,ffmpeg-codecs},
+@url{ffmpeg-bitstream-filters,ffmpeg-bitstream-filters},
+@url{ffmpeg-formats.html,ffmpeg-formats},
+@url{ffmpeg-devices.html,ffmpeg-devices},
+@url{ffmpeg-protocols.html,ffmpeg-protocols},
+@url{ffmpeg-filters.html,ffmpeg-filters}
+@end ifhtml
+
+@ifnothtml
+The @file{doc/ffserver.conf} example, ffmpeg(1), ffplay(1), ffprobe(1),
+ffmpeg-utils(1), ffmpeg-scaler(1), ffmpeg-resampler(1),
+ffmpeg-codecs(1), ffmpeg-bitstream-filters(1), ffmpeg-formats(1),
+ffmpeg-devices(1), ffmpeg-protocols(1), ffmpeg-filters(1)
+@end ifnothtml
+
@include authors.texi
@ignore
@@ -267,12 +290,6 @@ messages to stdout.
@setfilename ffserver
@settitle ffserver video server
-@c man begin SEEALSO
-
-ffmpeg(1), ffplay(1), ffprobe(1), the @file{ffserver.conf}
-example and the FFmpeg HTML documentation
-@c man end
-
@end ignore
@bye