From 6a05eee80a0cd96c37093000ddfeb823cbd0678b Mon Sep 17 00:00:00 2001 From: paul Date: Fri, 5 Dec 2008 08:19:51 +0000 Subject: [PATCH] template-ized tools man pages and add Makefile for them (still to do - edit contents, because they are pretty useless) git-svn-id: svn+ssh://jackaudio.org/trunk/jack@3165 0c269be4-1314-0410-8aa9-9f06e86f4224 --- configure.ac | 1 + man/Makefile.am | 10 ++++++++++ man/{jack_bufsize.1 => jack_bufsize.0} | 2 +- man/jack_connect.0 | 12 ++++++++++++ man/jack_connect.1 | 17 ----------------- man/jack_disconnect.0 | 13 +++++++++++++ man/jack_disconnect.1 | 17 ----------------- man/{jack_freewheel.1 => jack_freewheel.0} | 2 +- ...impulse_grabber.1 => jack_impulse_grabber.0} | 2 +- man/{jack_load.1 => jack_load.0} | 2 +- man/{jack_lsp.1 => jack_lsp.0} | 2 +- man/{jack_metro.1 => jack_metro.0} | 2 +- ...k_monitor_client.1 => jack_monitor_client.0} | 2 +- man/{jack_showtime.1 => jack_showtime.0} | 2 +- ...ack_simple_client.1 => jack_simple_client.0} | 2 +- man/{jack_transport.1 => jack_transport.0} | 2 +- man/{jack_unload.1 => jack_unload.0} | 2 +- man/jackrec.0 | 10 ++++++++++ man/jackrec.1 | 14 -------------- 19 files changed, 57 insertions(+), 59 deletions(-) create mode 100644 man/Makefile.am rename man/{jack_bufsize.1 => jack_bufsize.0} (89%) create mode 100644 man/jack_connect.0 delete mode 100644 man/jack_connect.1 create mode 100644 man/jack_disconnect.0 delete mode 100644 man/jack_disconnect.1 rename man/{jack_freewheel.1 => jack_freewheel.0} (90%) rename man/{jack_impulse_grabber.1 => jack_impulse_grabber.0} (87%) rename man/{jack_load.1 => jack_load.0} (92%) rename man/{jack_lsp.1 => jack_lsp.0} (84%) rename man/{jack_metro.1 => jack_metro.0} (92%) rename man/{jack_monitor_client.1 => jack_monitor_client.0} (91%) rename man/{jack_showtime.1 => jack_showtime.0} (85%) rename man/{jack_simple_client.1 => jack_simple_client.0} (92%) rename man/{jack_transport.1 => jack_transport.0} (90%) rename man/{jack_unload.1 => jack_unload.0} (91%) create mode 100644 man/jackrec.0 delete mode 100644 man/jackrec.1 diff --git a/configure.ac b/configure.ac index 21ad563..f987a27 100644 --- a/configure.ac +++ b/configure.ac @@ -878,6 +878,7 @@ drivers/firewire/Makefile drivers/netjack/Makefile example-clients/Makefile tools/Makefile +man/Makefile jack.pc jack.spec jack/Makefile diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 0000000..5b5e356 --- /dev/null +++ b/man/Makefile.am @@ -0,0 +1,10 @@ +.0.1: + @sed -e "s/!VERSION!/@JACK_RELEASE@/g" -e "s/!DATE!/`date '+%B %Y'`/g" < $*.0 > $@ + @echo Built $*.1 from template + +manpages := $(patsubst %.0,%.1,$(wildcard *.0)) + +all: $(manpages) + +clean: + -rm $(manpages) \ No newline at end of file diff --git a/man/jack_bufsize.1 b/man/jack_bufsize.0 similarity index 89% rename from man/jack_bufsize.1 rename to man/jack_bufsize.0 index d241214..b35ee4f 100644 --- a/man/jack_bufsize.1 +++ b/man/jack_bufsize.0 @@ -1,4 +1,4 @@ -.TH JACK_BUFSIZE "1" "December 2003" "0.91.1" +.TH JACK_BUFSIZE "!DATE!" "!VERSION!" .SH NAME jack_bufsize \- The JACK Audio Connection Kit example client .SH SYNOPSYS diff --git a/man/jack_connect.0 b/man/jack_connect.0 new file mode 100644 index 0000000..4f1f3d4 --- /dev/null +++ b/man/jack_connect.0 @@ -0,0 +1,12 @@ +.TH JACK_CONNECT "!DATE!" "!VERSION!" +.SH NAME +jack_connect \- A JACK Audio Connection Kit toolkit client +.SH SYNOPSYS +.B jack_connect +[ -s | --server servername ] [ -h | --help ] port1 port2 +.SH DESCRIPTION +.B jack_connect +connects the two named ports. +.SH RETURNS +The exit status is zero if successful, 1 otherwise + diff --git a/man/jack_connect.1 b/man/jack_connect.1 deleted file mode 100644 index b59460e..0000000 --- a/man/jack_connect.1 +++ /dev/null @@ -1,17 +0,0 @@ -.TH JACK_CONNECT "1" "June 2002" "0.91.1" -.SH NAME -jack_connect \- The JACK Audio Connection Kit example client -.SH SYNOPSYS -.B jack_connect -src_port dst_port -.PP -The source port must be an output port of the source client. -The destination port must be an input port of the destination client. -.SH DESCRIPTION -.B jack_connect -is an example client for the JACK Audio Connection Kit. -.SH AUTHOR -Jeremy Hall -.PP -This manpage was written by Stefan Schwandter - diff --git a/man/jack_disconnect.0 b/man/jack_disconnect.0 new file mode 100644 index 0000000..a761d5d --- /dev/null +++ b/man/jack_disconnect.0 @@ -0,0 +1,13 @@ +.TH JACK_DISCONNECT "!DATE!" "!VERSION!" +.SH NAME +jack_disconnect \- A JACK Audio Connection Kit toolkit client +.SH SYNOPSYS +.B jack_disconnect +port1 port2 +.SH DESCRIPTION +.B jack_disconnect +disconnects the two named ports. +.SH RETURNS +The exit status is zero if successful, 1 otherwise. + + diff --git a/man/jack_disconnect.1 b/man/jack_disconnect.1 deleted file mode 100644 index d975777..0000000 --- a/man/jack_disconnect.1 +++ /dev/null @@ -1,17 +0,0 @@ -.TH JACK_DISCONNECT "1" "June 2002" "0.91.1" -.SH NAME -jack_disconnect \- The JACK Audio Connection Kit example client -.SH SYNOPSYS -.B jack_disconnect -src_port dst_port -.PP -The source port must be an output port of the source client. -The destination port must be an input port of the destination client. -.SH DESCRIPTION -.B jack_disconnect -is an example client for the JACK Audio Connection Kit. -.SH AUTHORS -Paul Davis and others. -.PP -This manpage was written by Stefan Schwandter - diff --git a/man/jack_freewheel.1 b/man/jack_freewheel.0 similarity index 90% rename from man/jack_freewheel.1 rename to man/jack_freewheel.0 index 4a58e4c..1e6c536 100644 --- a/man/jack_freewheel.1 +++ b/man/jack_freewheel.0 @@ -1,4 +1,4 @@ -.TH JACK_FREEWHEEL "1" "December 2003" "0.91.1" +.TH JACK_FREEWHEEL "!DATE!" "!VERSION!" .SH NAME jack_freewheel \- The JACK Audio Connection Kit example client .SH SYNOPSYS diff --git a/man/jack_impulse_grabber.1 b/man/jack_impulse_grabber.0 similarity index 87% rename from man/jack_impulse_grabber.1 rename to man/jack_impulse_grabber.0 index 4357d14..aacdb2c 100644 --- a/man/jack_impulse_grabber.1 +++ b/man/jack_impulse_grabber.0 @@ -1,4 +1,4 @@ -.TH JACK_IMPULSE_GRABBER "1" "June 2002" "0.91.1" +.TH JACK_IMPULSE_GRABBER "!DATE!" "!VERSION!" .SH NAME jack_impulse_grabber \- The JACK Audio Connection Kit example client .SH SYNOPSYS diff --git a/man/jack_load.1 b/man/jack_load.0 similarity index 92% rename from man/jack_load.1 rename to man/jack_load.0 index a5818e9..9e999ec 100644 --- a/man/jack_load.1 +++ b/man/jack_load.0 @@ -1,4 +1,4 @@ -.TH JACK_LOAD "1" "August 2003" "0.91.1" +.TH JACK_LOAD "!DATE!" "!VERSION!" .SH NAME jack_load \- The JACK Audio Connection Kit example client .SH SYNOPSYS diff --git a/man/jack_lsp.1 b/man/jack_lsp.0 similarity index 84% rename from man/jack_lsp.1 rename to man/jack_lsp.0 index 43a3ff4..f365763 100644 --- a/man/jack_lsp.1 +++ b/man/jack_lsp.0 @@ -1,4 +1,4 @@ -.TH JACK_LSP "1" "September 2002" "0.91.1" +.TH JACK_LSP "!DATE!" "!VERSION!" .SH NAME jack_lsp \- The JACK Audio Connection Kit example client .SH SYNOPSYS diff --git a/man/jack_metro.1 b/man/jack_metro.0 similarity index 92% rename from man/jack_metro.1 rename to man/jack_metro.0 index 14e2829..414a102 100644 --- a/man/jack_metro.1 +++ b/man/jack_metro.0 @@ -1,4 +1,4 @@ -.TH JACK_METRO "1" "September 2002" "0.91.1" +.TH JACK_METRO "!DATE!" "!VERSION!" .SH NAME jack_metro \- The JACK Audio Connection Kit example client .SH SYNOPSYS diff --git a/man/jack_monitor_client.1 b/man/jack_monitor_client.0 similarity index 91% rename from man/jack_monitor_client.1 rename to man/jack_monitor_client.0 index 1a9e06a..30f1cd1 100644 --- a/man/jack_monitor_client.1 +++ b/man/jack_monitor_client.0 @@ -1,4 +1,4 @@ -.TH JACK_CONNECT "1" "August 2003" "0.91.1" +.TH JACK_CONNECT "!DATE!" "!VERSION!" .SH NAME jack_monitor_client \- The JACK Audio Connection Kit example client .SH SYNOPSYS diff --git a/man/jack_showtime.1 b/man/jack_showtime.0 similarity index 85% rename from man/jack_showtime.1 rename to man/jack_showtime.0 index 9818b8b..f4ac165 100644 --- a/man/jack_showtime.1 +++ b/man/jack_showtime.0 @@ -1,4 +1,4 @@ -.TH JACK_SHOWTIME "1" "September 2002" "0.91.1" +.TH JACK_SHOWTIME "!DATE!" "!VERSION!" .SH NAME jack_showtime \- The JACK Audio Connection Kit example client .SH SYNOPSYS diff --git a/man/jack_simple_client.1 b/man/jack_simple_client.0 similarity index 92% rename from man/jack_simple_client.1 rename to man/jack_simple_client.0 index c950af9..19d05c4 100644 --- a/man/jack_simple_client.1 +++ b/man/jack_simple_client.0 @@ -1,4 +1,4 @@ -.TH JACK_CONNECT "1" "August 2003" "0.91.1" +.TH JACK_CONNECT "!DATE!" "!VERSION!" .SH NAME jack_simple_client \- The JACK Audio Connection Kit example client .SH SYNOPSYS diff --git a/man/jack_transport.1 b/man/jack_transport.0 similarity index 90% rename from man/jack_transport.1 rename to man/jack_transport.0 index 7eb6228..51b6e7e 100644 --- a/man/jack_transport.1 +++ b/man/jack_transport.0 @@ -1,4 +1,4 @@ -.TH JACK_TRANSPORT "1" "August 2003" "0.91.1" +.TH JACK_TRANSPORT "!DATE!" "!VERSION!" .SH NAME jack_transport \- The JACK Audio Connection Kit example client .SH SYNOPSYS diff --git a/man/jack_unload.1 b/man/jack_unload.0 similarity index 91% rename from man/jack_unload.1 rename to man/jack_unload.0 index 1d3efa5..e43a08b 100644 --- a/man/jack_unload.1 +++ b/man/jack_unload.0 @@ -1,4 +1,4 @@ -.TH JACK_UNLOAD "1" "August 2003" "0.91.1" +.TH JACK_UNLOAD "!DATE!" "!VERSION!" .SH NAME jack_unload \- The JACK Audio Connection Kit example client .SH SYNOPSYS diff --git a/man/jackrec.0 b/man/jackrec.0 new file mode 100644 index 0000000..c89da2b --- /dev/null +++ b/man/jackrec.0 @@ -0,0 +1,10 @@ +.TH JACKREC "!DATE!" "!VERSION!" +.SH NAME +jackrec \- The JACK Audio Connection Kit example client +.SH SYNOPSYS +.B jackrec +-f filename [ -d second ] [ -b bitdepth ] port1 [ port2 ... ] +.SH DESCRIPTION +.B jackrec + + diff --git a/man/jackrec.1 b/man/jackrec.1 deleted file mode 100644 index d78332d..0000000 --- a/man/jackrec.1 +++ /dev/null @@ -1,14 +0,0 @@ -.TH JACKREC "1" "June 2002" "0.91.1" -.SH NAME -jackrec \- The JACK Audio Connection Kit example client -.SH SYNOPSYS -.B jackrec --f filename [ -d second ] [ -b bitdepth ] port1 [ port2 ... ] -.SH DESCRIPTION -.B jackrec -is an example client for the JACK Audio Connection Kit. -.SH AUTHORS -Paul Davis and others. -.PP -This manpage was written by Stefan Schwandter -