Commit graph

7 commits

Author SHA1 Message Date
Antonio Ospite 2a5a8dd3c7 tools: ship the final man pages directly, no more man pages templates
Don't use templates for the man pages, the API version change is a rare
event, so it's not really worth keeping in place the "sed" boilerplate
to have it set at build time.

Shipping the final man pages directly also makes it easer to install the
man pages with meson (in a future commit).

Note that now all the occurrences of the programs names have the API
version as a suffix.

Traditionally the example command lines looked like:

  gst-launch ...

Now they look like:

  gst-launch-1.0 ...

This reflects the actual programs names and makes it easier to copy and
paste the example commands.

Also, the .gitignore file is adjusted not to ignore the final man pages
anymore.

You may need to clean your src/build directory before pulling in this
patch.

https://bugzilla.gnome.org/show_bug.cgi?id=773917
2016-11-23 09:09:05 +00:00
Antonio Ospite ef3a60793b tools: don't mention gst-feedback in man pages
gst-feedback no longer exists.

https://bugzilla.gnome.org/show_bug.cgi?id=773917
2016-11-11 09:59:40 +00:00
Antonio Ospite 64c097d296 tools: escape dashes in the man pages
The portable way to have the dashes to be rendered as ASCII minuses is
to use the sequence backslash-dash, use this style at least for text
that can be copied and pasted (e.g. command names, file names, element
options).

Also use backslash-dash in the NAME section as suggested by lexgrog(1).

https://bugzilla.gnome.org/show_bug.cgi?id=773917
2016-11-11 09:55:16 +00:00
Michael Bunk 6df8250d01 docs: fix typo on gst-inspect man page
See #624164.
2010-07-16 18:20:57 +01:00
Steve Fink 3dc3b453db tools/gst-inspect.1.in: Document --print-all and --print-plugin-auto-install-info command line options in man page.
Original commit message from CVS:
Patch by: Steve Fink  <sphink gmail com>
* tools/gst-inspect.1.in:
Document --print-all and --print-plugin-auto-install-info command
line options in man page.
2007-07-25 22:29:57 +00:00
Stefan Kost 334b141a32 tools/: cleanup man-pages, remove reference to gst-register, document env-vars
Original commit message from CVS:
* tools/README:
* tools/gst-feedback.1.in:
* tools/gst-inspect.1.in:
* tools/gst-launch.1.in:
* tools/gst-md5sum.1.in:
* tools/gst-typefind.1.in:
* tools/gst-xmlinspect.1.in:
* tools/gst-xmllaunch.1.in:
cleanup man-pages, remove reference to gst-register, document env-vars
2006-01-12 16:31:35 +00:00
David Schleef 4b1d031c6b Move man pages from %.1 to %.1.in, and add a rule to make .1 files from .1.in, replacing program names with their ver...
Original commit message from CVS:
Move man pages from %.1 to %.1.in, and add a rule to make .1 files
from .1.in, replacing program names with their versioned equivalent.
Handles nroff escape code for - (\-).
2003-08-15 20:25:40 +00:00
Renamed from tools/gst-inspect.1 (Browse further)