From ddb509b5d4a92c11bd15ae5d03296d30a58662bc Mon Sep 17 00:00:00 2001 From: x42 Date: Mon, 1 Nov 2010 15:00:14 +0000 Subject: [PATCH] added man-pages. git-svn-id: https://gjacktransport.svn.sourceforge.net/svnroot/gjacktransport/trunk@59 4365b5fc-4a28-0410-96b5-80621495d1de --- Makefile.am | 6 ++++- debian/gjackclock.install | 1 + debian/gjacktransport.install | 1 + doc/gjackclock.1 | 42 +++++++++++++++++++++++++++++++++++ doc/gjacktransport.1 | 51 +++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 100 insertions(+), 1 deletion(-) create mode 100644 doc/gjackclock.1 create mode 100644 doc/gjacktransport.1 diff --git a/Makefile.am b/Makefile.am index ae6cd5c..f9ff496 100644 --- a/Makefile.am +++ b/Makefile.am @@ -2,12 +2,16 @@ SUBDIRS = src po +man_MANS = doc/gjacktransport.1 doc/gjackclock.1 + EXTRA_DIST = \ autogen.sh \ gjacktransport.glade \ gjacktransport.gladep \ pixmaps/gjacktransport.png \ - pixmaps/gjackclock.png + pixmaps/gjackclock.png \ + doc/gjacktransport.1 \ + doc/gjackclock.1 install-data-local: @$(NORMAL_INSTALL) diff --git a/debian/gjackclock.install b/debian/gjackclock.install index 30c7e3d..88c078b 100644 --- a/debian/gjackclock.install +++ b/debian/gjackclock.install @@ -2,3 +2,4 @@ usr/bin/gjackclock usr/share/pixmaps/gjackclock.png etc/gjackclockrc debian/gjackclock.desktop /usr/share/applications +usr/share/man/man1/gjackclock.1 diff --git a/debian/gjacktransport.install b/debian/gjacktransport.install index 58aaa35..8d0a0a9 100644 --- a/debian/gjacktransport.install +++ b/debian/gjacktransport.install @@ -2,3 +2,4 @@ usr/bin/gjacktransport usr/share/pixmaps/gjacktransport.png etc/gjacktransportrc debian/gjacktransport.desktop /usr/share/applications +usr/share/man/man1/gjacktransport.1 diff --git a/doc/gjackclock.1 b/doc/gjackclock.1 new file mode 100644 index 0000000..6a5a04f --- /dev/null +++ b/doc/gjackclock.1 @@ -0,0 +1,42 @@ +.TH gjackclock 1 "November 1, 2010" "http://gjacktransport\&.sf\&.net" "JACK transport clock" + +.SH NAME +gjackclock \- JACK transport "Big Clock" + +.SH SYNOPSIS +.B gjackclock +.RI [ options ] +.br + +.SH DESCRIPTION +.B gjackclock +is a standalone JACK transport "Big Clock" display. +.PP +It is a simple window application displaying JACK transport time-code featuring: + * customizable font, size & colors + * fixed FPS setting or FPS from jack-timebase-master + * jack-transport control via key-bindings + * read settings from .rc file. + +.SH OPTIONS +run gjackclock \-\-help for a list of options + +.SH FILES + @sysconfdir@/gjackclockrc + +.SH EXAMPLE +gjackclock \-C black \-c yellow \-S Sans \-s 60 + +.SH "SEE ALSO" +.PP +gjacktransport(1) +.SH "AUTHOR" +.PP +\fBRobin Gareus\fR <\&robin@gareus.org\&> +.RS 4 +linuxaudio.org +.RE +.SH "COPYRIGHT" +.br +Copyright \(co 2007, 2010 Robin Gareus +.br diff --git a/doc/gjacktransport.1 b/doc/gjacktransport.1 new file mode 100644 index 0000000..81c1de4 --- /dev/null +++ b/doc/gjacktransport.1 @@ -0,0 +1,51 @@ +.TH gjacktransport 1 "November 1, 2010" "http://gjacktransport\&.sf\&.net" "JACK transport control" + +.SH NAME +gjacktransport \- JACK transport control application + +.SH SYNOPSIS +.B gjacktransport +.RI [ options ] +.br + +.SH DESCRIPTION +.B gjacktransport +gjacktransport is a tool that provides graphical control +over JACK Audio Connection Kit's transport mechanism via +a dynamic graphical slider. +.PP +In other words: this software allows to seek Audio/Video media +when they are played along JACK transport. +.PP +It features + * customizable keyboard shortcuts + * custom start/end markers for transport slider in various units + * memory presets for start/end markers. + * auto-zoom and reposition slider + * flexible layout & window + * save and restore settings. + * (optional) session-management via LASH. +.PP +and is intended for JACK apps which do not themselves provide a +timeline (fi. ecasound, xjadeo,..) and to supplement other apps +which do (fi. ardour, hydrogen, seq24,..) + +.SH OPTIONS +run gjacktransport \-\-help for a list of options + +.SH FILES + @sysconfdir@/gjacktransportrc + +.SH "SEE ALSO" +.PP +gjackclock(1) +.SH "AUTHOR" +.PP +\fBRobin Gareus\fR <\&robin@gareus.org\&> +.RS 4 +linuxaudio.org +.RE +.SH "COPYRIGHT" +.br +Copyright \(co 2007, 2010 Robin Gareus +.br -- 2.11.4.GIT