Commit graph

58 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
76656050b5 tools: put the examples descriptions before the commands in man page
Put the description of the example command lines before the command
instead of after them. The new way is more intuitive.

https://bugzilla.gnome.org/show_bug.cgi?id=773917
2016-11-11 09:58:40 +00:00
Antonio Ospite
7521d5b3cf tools: don't start lines with single quotes in man page
When a line starts with a single quote it's treated in a special way by
man, which may result in paragraphs of the man page not rendered by the
man pager, so just avoid that.

A possible solution could have been to escape the singe quote with
a \(cq sequence but this is rather unreadable, instead the text has been
reformatted to have the problematic quoted 'ppc' string on the previous
line.

https://bugzilla.gnome.org/show_bug.cgi?id=773917
2016-11-11 09:57:39 +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
Jan Schmidt
5a5ae1be1f parse-launch: Support linking all pads with new operator
Introduce a new operator ':' - e.g. element1 ':' element2

For example, 'uridecodebin : encodebin' -
if the encodebin has multiple profiles compatible with the
decodebin, multiple links will be created.

With '!' , after one delayed link is successfully done, the
pad-added callback is disconnected.

https://bugzilla.gnome.org/show_bug.cgi?id=751450
2016-11-02 12:04:33 +11:00
Jan Schmidt
9e23670671 Update the examples in the gst-launch-1.0 manpage
Replace elements that don't exist any more with ones
that do, and insert elements like mpegaudioparse where
they are needed.

https://bugzilla.gnome.org/show_bug.cgi?id=727105
2016-05-13 18:05:39 +10:00
Tim-Philipp Müller
bc5c199bc5 docs: mention xdot utility to view .dot files directly 2015-10-16 15:59:49 +01:00
Sebastian Dröge
7f9c0d06dd docs: There is no decodebin2 anymore, don't pretend otherwise 2014-07-08 11:18:05 +02:00
Edward Hervey
98ea309bea gst-launch.1: Playbin2 is dead, long live playbin
Looks like that was the last remaining mention in core ...
2014-04-03 07:37:11 +02:00
Руслан Ижбулатов
797fcd1d49 info: Add debug color mode option
This allows to explicitely set the debug output color
mode to UNIX on every platform, enable it (use platform
default color mode) or enable it.

https://bugzilla.gnome.org/show_bug.cgi?id=674320
2013-07-18 14:30:44 +02:00
Tim-Philipp Müller
b22385af0a docs: flesh out gst-launch-1.0 man page a little
Fix up default location of the registry.

Mention more options for GST_DEBUG (wildcards and
named debug levels).

Explain what to do with the dot files that can be
produced by setting GST_DEBUG_DUMP_DOT_DIR.

https://bugzilla.gnome.org/show_bug.cgi?id=693607
2013-02-13 23:27:16 +00:00
Tim-Philipp Müller
c015b70456 tools: minor addition to gst-launch-1.0 man page
https://bugzilla.gnome.org/show_bug.cgi?id=692015
2013-01-18 16:05:09 +00:00
Tim-Philipp Müller
1ccf9cf006 tools: update gst-launch-1.0 man page for new debug levels
There are more debug levels these days, not only 0-5.

https://bugzilla.gnome.org/show_bug.cgi?id=692015
2013-01-18 16:01:11 +00:00
Olivier Crête
1d41a8002b Document GST_DEBUG_FILE 2012-11-06 18:30:31 +01:00
Wim Taymans
a87e95f38f docs: updates
MIME-type -> Media type
Fix some old gst-inspect output
2012-09-25 17:06:45 +02:00
Bastian Winkler
771d061658 man: Fix syntax for value lists in caps strings
Value lists use curly brackets instead of parentheses

https://bugzilla.gnome.org/show_bug.cgi?id=684293
2012-09-21 11:47:23 +01:00
Wim Taymans
8db60df244 docs: fourcc is no more 2012-09-13 11:38:33 +02:00
Wim Taymans
3abc720345 docs: fix some docs
from git grep for ffmpegcolorspace and x-raw-
2012-09-13 11:35:41 +02:00
Tim-Philipp Müller
fc0d6ce23a tools: minor fixes to gst-launch man page 2012-08-18 21:42:23 +01:00
Sebastian Dröge
b0d89da6b6 gst: Change versioning
Remove GST_MAJORMINOR and replace it by GST_API_VERSION
Also set GST_VERSION_{MAJOR,MINOR,MICRO,NANO} explicitely
now.

All versions are at 1.0.0 now for the release soon but
API/ABI can still change until the 1.0.0 release.

Next release versions until 1.0.0 will be 0.10.9X and
these will be release candidates. GST_VERSION_* will
nonetheless stay at 1.0.0.0.
2012-04-04 14:28:55 +02:00
Tim-Philipp Müller
a4092cd5c4 Remove everything libxml2- and loadsave-related 2011-06-04 15:22:06 +01:00
Tim-Philipp Müller
0bf43651a9 tools: remove SIGUSR* handling from gst-launch
Remove SIGUSR* handling from gst-launch, since it might interfere
with other things (e.g. libleaks), and should be done differently
anyway (either via support for simple timed-commands scripting or
remote control via DBus or so).
2011-06-04 14:41:16 +01:00
Stefan Kost
88cda98939 gst-launch: add index support
When option "-i" is given, set an index object on the pipeline and compute
statistics for all index writers. Print a sumary when shutting down the
pipeline.
2011-02-24 15:36:47 +02:00
Tim-Philipp Müller
6fef105491 docs: minor gst-launch man page fix
Transmitter/receiver pipelines were mislabelled. Spotted by Majin.
2011-01-25 09:17:55 +00:00
David Schleef
95cd0ab6e4 gst-launch: Fix OIL_CPU_FLAGS docs for Orc 2010-08-24 12:51:41 -07:00
Stefan Kost
58b8319f9c man: remove OIL_CPU_FLAGS from man page
We're using ORC instead of libOil now.
2010-08-24 16:25:16 +03:00
Tim-Philipp Müller
bd03793273 tools: remove -p shorthand for --no-sigusr-handler
It's not really needed, and doesn't map any longer after the long option
has been renamed.
2010-07-08 13:43:22 +01:00
Tim-Philipp Müller
d989fa3cf1 tools: mention --eos-on-shutdown on gst-launch man page 2010-06-28 13:56:00 +01:00
Tim-Philipp Müller
1210e4a006 gst-launch: rename new --no-play command line option to --no-sigusr-handler
--no-play seems a bit confusing.

Fixes #621867.
2010-06-24 17:27:09 +01:00
Stefan Kost
7c4e0537d3 gst-launch: add -p option to disable play handler.
Same logic as for the fault handler. This is useful for some debug/tracing tools
that need to grab SIGUSR1 and SIGUSR2 them self.
2010-04-30 10:03:38 +03:00
Tim-Philipp Müller
5f8b121619 docs: add another example to the gst-launch man page
Add an example that shows how to refer to specific pads by name
when constructing a pipeline string. Fixes #600382.
2009-11-03 01:23:03 +00:00
Stefan Kost
bc6b1db5e9 man: fix copy and past mistake for -q option 2009-10-07 10:59:54 +03:00
Tim-Philipp Müller
23cdff62ea docs: fix cdparanoia example pipeline in gst-launch man page 2009-05-26 09:51:51 +01:00
Tim-Philipp Müller
927d016461 docs: gst-launch man page fix
The command line option is --gst-debug-disable, not --gst-disable-debug.
Fixes #576556. Spotted by Bogdan Harjoc.
2009-03-24 21:39:21 +00:00
Stefan Kost
a12b0a60d8 gst-launch: add -q/--quiet option to supress any non error output.
Having no output is nice for scripting. Also update the manpage.
2009-02-15 16:40:43 +02:00
Stefan Kost
38077f85ab tools/gst-launch.1.in: Fix description of how to specify a type in caps. Fixes #553873.
Original commit message from CVS:
* tools/gst-launch.1.in:
Fix description of how to specify a type in caps. Fixes #553873.
Also ranges and list contain values and not property-assignments.
2008-12-09 09:00:57 +00:00
Tim-Philipp Müller
bfd08292ec tools/gst-launch.1.in: Document GST_REGISTRY_UPDATE environment variable.
Original commit message from CVS:
* tools/gst-launch.1.in:
Document GST_REGISTRY_UPDATE environment variable.
2008-08-18 11:28:00 +00:00
Stefan Kost
323cdbe71d tools/gst-launch.1.in: Forgot to also add the envvar docs here.
Original commit message from CVS:
* tools/gst-launch.1.in:
Forgot to also add the envvar docs here.
2008-04-25 13:09:40 +00:00
Wim Taymans
1f82509570 tools/gst-launch.1.in: Add colorspace to example pipeline. Fixes #458274.
Original commit message from CVS:
* tools/gst-launch.1.in:
Add colorspace to example pipeline. Fixes #458274.
2007-08-20 17:51:35 +00:00
Tim-Philipp Müller
5dd3c7d9a2 tools/: Don't create a customised man page based on the host architecture, describe the default registry path generic...
Original commit message from CVS:
* tools/Makefile.am:
* tools/gst-launch.1.in:
Don't create a customised man page based on the host architecture,
describe the default registry path generically. That way the man
page is the same for all architectures and packagers have one
multilib issue less to deal with. Fixes #434926.
2007-05-02 17:09:30 +00:00
Michael Smith
bfbbd14a04 tools/gst-launch.1.in: fractions are better supported in gstreamer than ractions, so suggest using those.
Original commit message from CVS:
* tools/gst-launch.1.in:
fractions are better supported in gstreamer than ractions, so
suggest using those.
2007-04-05 16:17:24 +00:00
Stefan Kost
a75461ff0d tools/gst-launch.1.in: Give example for network streaming (#351998)
Original commit message from CVS:
* tools/gst-launch.1.in:
Give example for network streaming (#351998)
2007-02-02 12:27:16 +00:00
Tim-Philipp Müller
17132b00f6 tools/gst-launch.1.in: Un-garble (fourcc) bit in filtered caps section.
Original commit message from CVS:
* tools/gst-launch.1.in:
Un-garble (fourcc) bit in filtered caps section.
2006-06-16 14:31:07 +00:00
Tim-Philipp Müller
2bafa6ab0d tools/gst-launch.1.in: Fix another typo.
Original commit message from CVS:
* tools/gst-launch.1.in:
Fix another typo.
2006-03-22 09:03:10 +00:00
Tim-Philipp Müller
899f2f8244 tools/: Add FILES section and correct entry about GST_REGISTRY_PATH environment variable (#133495; #133494).
Original commit message from CVS:
* tools/Makefile.am:
* tools/gst-launch.1.in:
Add FILES section and correct entry about GST_REGISTRY_PATH
environment variable (#133495; #133494).
2006-03-21 15:04:20 +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
Stefan Kost
08501e5b3a docs/random/ensonic/media-device-daemon.txt: more ideas (dbus)
Original commit message from CVS:
* docs/random/ensonic/media-device-daemon.txt:
more ideas (dbus)
* gst/gstbuffer.c:
fix doc example, add clarification
* tools/gst-launch.1.in:
add initial info about GST_PLUGIN_PATH, needs more work
2006-01-11 19:18:27 +00:00
Tim-Philipp Müller
a1ed4ed852 tools/gst-launch.1.in: Update gst-launch man page; add a section with useful environment variables. Fixes #323882.
Original commit message from CVS:
* tools/gst-launch.1.in:
Update gst-launch man page; add a section with useful
environment variables. Fixes #323882.
2005-12-17 14:19:27 +00:00
Thomas Vander Stichele
3dfcce5a99 remove mentions of sinesrc
Original commit message from CVS:
remove mentions of sinesrc
2005-11-23 15:49:06 +00:00
Michael Smith
20d6576ebd Correct syntax for debug option in gst-launch manpage
Original commit message from CVS:
Correct syntax for debug option in gst-launch manpage
2005-09-26 13:40:21 +00:00