Added a manual page for mixer(1)
This commit is contained in:
parent
f6f7da1bd5
commit
6ae3d2b7ec
6
Makefile
6
Makefile
|
|
@ -1,6 +1,6 @@
|
|||
PACKAGE = Mixer
|
||||
VERSION = 0.1.1
|
||||
SUBDIRS = data po src
|
||||
SUBDIRS = data doc po src
|
||||
RM = rm -f
|
||||
LN = ln -f
|
||||
TAR = tar -czvf
|
||||
|
|
@ -24,6 +24,10 @@ dist:
|
|||
$(PACKAGE)-$(VERSION)/data/Makefile \
|
||||
$(PACKAGE)-$(VERSION)/data/mixer.desktop \
|
||||
$(PACKAGE)-$(VERSION)/data/project.conf \
|
||||
$(PACKAGE)-$(VERSION)/doc/Makefile \
|
||||
$(PACKAGE)-$(VERSION)/doc/docbook.sh \
|
||||
$(PACKAGE)-$(VERSION)/doc/mixer.xml \
|
||||
$(PACKAGE)-$(VERSION)/doc/project.conf \
|
||||
$(PACKAGE)-$(VERSION)/po/Makefile \
|
||||
$(PACKAGE)-$(VERSION)/po/gettext.sh \
|
||||
$(PACKAGE)-$(VERSION)/po/POTFILES \
|
||||
|
|
|
|||
33
doc/Makefile
Normal file
33
doc/Makefile
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
TARGETS = mixer.1 mixer.html
|
||||
PREFIX = /usr/local
|
||||
DESTDIR =
|
||||
RM = rm -f
|
||||
LN = ln -f
|
||||
MKDIR = mkdir -m 0755 -p
|
||||
INSTALL = install
|
||||
|
||||
|
||||
all: $(TARGETS)
|
||||
|
||||
mixer.1: mixer.xml
|
||||
./docbook.sh -P "$(PREFIX)" -- "mixer.1"
|
||||
|
||||
mixer.html: mixer.xml
|
||||
./docbook.sh -P "$(PREFIX)" -- "mixer.html"
|
||||
|
||||
clean:
|
||||
$(RM) -- $(mixer.1_OBJS) $(mixer.html_OBJS)
|
||||
./docbook.sh -c -P "$(PREFIX)" -- "mixer.html"
|
||||
|
||||
distclean: clean
|
||||
$(RM) -- $(TARGETS)
|
||||
|
||||
install: $(TARGETS)
|
||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "mixer.1"
|
||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "mixer.html"
|
||||
|
||||
uninstall:
|
||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "mixer.1"
|
||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "mixer.html"
|
||||
|
||||
.PHONY: all clean distclean install uninstall
|
||||
138
doc/docbook.sh
Executable file
138
doc/docbook.sh
Executable file
|
|
@ -0,0 +1,138 @@
|
|||
#!/bin/sh
|
||||
#$Id$
|
||||
#Copyright (c) 2012-2013 Pierre Pronchery <khorben@defora.org>
|
||||
#
|
||||
#Redistribution and use in source and binary forms, with or without
|
||||
#modification, are permitted provided that the following conditions are met:
|
||||
#
|
||||
# * Redistributions of source code must retain the above copyright notice, this
|
||||
# list of conditions and the following disclaimer.
|
||||
# * Redistributions in binary form must reproduce the above copyright notice,
|
||||
# this list of conditions and the following disclaimer in the documentation
|
||||
# and/or other materials provided with the distribution.
|
||||
#
|
||||
#THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
#AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
#IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
#DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
#FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
#DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
#SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
#CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
#OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
#OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
|
||||
|
||||
#variables
|
||||
PREFIX="/usr/local"
|
||||
. "../config.sh"
|
||||
#executables
|
||||
DEBUG="_debug"
|
||||
INSTALL="install -m 0644"
|
||||
MKDIR="mkdir -m 0755 -p"
|
||||
RM="rm -f"
|
||||
XSLTPROC="xsltproc --nonet --xinclude"
|
||||
|
||||
|
||||
#functions
|
||||
#debug
|
||||
_debug()
|
||||
{
|
||||
echo "$@" 1>&2
|
||||
"$@"
|
||||
}
|
||||
|
||||
|
||||
#usage
|
||||
_usage()
|
||||
{
|
||||
echo "Usage: docbook.sh [-c|-i|-u][-P prefix] target..." 1>&2
|
||||
return 1
|
||||
}
|
||||
|
||||
|
||||
#main
|
||||
clean=0
|
||||
install=0
|
||||
uninstall=0
|
||||
while getopts "ciuP:" name; do
|
||||
case "$name" in
|
||||
c)
|
||||
clean=1
|
||||
;;
|
||||
i)
|
||||
uninstall=0
|
||||
install=1
|
||||
;;
|
||||
u)
|
||||
install=0
|
||||
uninstall=1
|
||||
;;
|
||||
P)
|
||||
PREFIX="$2"
|
||||
;;
|
||||
?)
|
||||
_usage
|
||||
exit $?
|
||||
;;
|
||||
esac
|
||||
done
|
||||
shift $((OPTIND - 1))
|
||||
if [ $# -eq 0 ]; then
|
||||
_usage
|
||||
exit $?
|
||||
fi
|
||||
|
||||
[ -z "$DATADIR" ] && DATADIR="$PREFIX/share"
|
||||
[ -z "$MANDIR" ] && MANDIR="$DATADIR/man"
|
||||
|
||||
while [ $# -gt 0 ]; do
|
||||
target="$1"
|
||||
source="${target%.*}.xml"
|
||||
shift
|
||||
|
||||
#determine the type
|
||||
ext="${target##*.}"
|
||||
ext="${ext##.}"
|
||||
case "$ext" in
|
||||
html)
|
||||
XSL="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"
|
||||
[ -f "${target%.*}.xsl" ] && XSL="${target%.*}.xsl"
|
||||
instdir="$DATADIR/doc/$ext/$PACKAGE"
|
||||
;;
|
||||
1|2|3|4|5|6|7|8|9)
|
||||
XSL="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"
|
||||
instdir="$MANDIR/man$ext"
|
||||
;;
|
||||
*)
|
||||
echo "$0: $target: Unknown type" 1>&2
|
||||
exit 2
|
||||
;;
|
||||
esac
|
||||
|
||||
#clean
|
||||
[ "$clean" -ne 0 ] && continue
|
||||
|
||||
#uninstall
|
||||
if [ "$uninstall" -eq 1 ]; then
|
||||
$DEBUG $RM -- "$instdir/$target" || exit 2
|
||||
continue
|
||||
fi
|
||||
|
||||
#install
|
||||
if [ "$install" -eq 1 ]; then
|
||||
$DEBUG $MKDIR -- "$instdir" || exit 2
|
||||
$DEBUG $INSTALL -- "$target" "$instdir/$target" || exit 2
|
||||
continue
|
||||
fi
|
||||
|
||||
#create
|
||||
$DEBUG $XSLTPROC -o "$target" "$XSL" "$source"
|
||||
#XXX ignore errors
|
||||
if [ $? -ne 0 ]; then
|
||||
echo "$0: $target: Could not create page" 1>&2
|
||||
$RM -- "$target"
|
||||
break
|
||||
fi
|
||||
done
|
||||
112
doc/mixer.xml
Normal file
112
doc/mixer.xml
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!-- $Id$ -->
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
||||
<!ENTITY firstname "Pierre">
|
||||
<!ENTITY surname "Pronchery">
|
||||
<!ENTITY username "khorben">
|
||||
<!ENTITY email "khorben@defora.org">
|
||||
<!ENTITY section "1">
|
||||
<!ENTITY title "Mixer User Manual">
|
||||
<!ENTITY package "DeforaOS Mixer">
|
||||
<!ENTITY name "mixer">
|
||||
<!ENTITY purpose "Volume mixer">
|
||||
]>
|
||||
<refentry>
|
||||
<refentryinfo>
|
||||
<title>&title;</title>
|
||||
<productname>&package;</productname>
|
||||
<authorgroup>
|
||||
<author>
|
||||
<firstname>&firstname;</firstname>
|
||||
<surname>&surname;</surname>
|
||||
<contrib>Code and documentation.</contrib>
|
||||
<address>
|
||||
<email>&email;</email>
|
||||
</address>
|
||||
</author>
|
||||
</authorgroup>
|
||||
<copyright>
|
||||
<year>2013</year>
|
||||
<holder>&firstname; &surname; <&email;></holder>
|
||||
</copyright>
|
||||
<legalnotice>
|
||||
<para>This manual page was written for the DeforaOS project (and may be
|
||||
used by others).</para>
|
||||
<para>Permission is granted to copy, distribute and/or modify this
|
||||
document under the terms of the GNU General Public License,
|
||||
Version 3 as published by the Free Software Foundation.</para>
|
||||
</legalnotice>
|
||||
</refentryinfo>
|
||||
<refmeta>
|
||||
<refentrytitle>&name;</refentrytitle>
|
||||
<manvolnum>§ion;</manvolnum>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>&name;</refname>
|
||||
<refpurpose>&purpose;</refpurpose>
|
||||
</refnamediv>
|
||||
<refsynopsisdiv>
|
||||
<cmdsynopsis>
|
||||
<command>&name;</command>
|
||||
<group choice="opt">
|
||||
<arg choice="plain"><option>-H</option></arg>
|
||||
<arg choice="plain"><option>-T</option></arg>
|
||||
<arg choice="plain"><option>-V</option></arg>
|
||||
</group>
|
||||
<arg choice="opt">
|
||||
<option>-d</option>
|
||||
<replaceable>device</replaceable>
|
||||
</arg>
|
||||
<arg choice="opt">
|
||||
<option>-x</option>
|
||||
</arg>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
<refsect1 id="description">
|
||||
<title>Description</title>
|
||||
<para><command>&name;</command> is a volume mixer.</para>
|
||||
</refsect1>
|
||||
<refsect1 id="options">
|
||||
<title>Options</title>
|
||||
<para>The following options are available:</para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><option>-H</option></term>
|
||||
<listitem>
|
||||
<para>Start the mixer in horizontal layout.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-T</option></term>
|
||||
<listitem>
|
||||
<para>Start the mixer in tabbed layout (default)</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-V</option></term>
|
||||
<listitem>
|
||||
<para>Start the mixer in vertical layout.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-d</option></term>
|
||||
<listitem>
|
||||
<para>Specify a specific device node to use.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-x</option></term>
|
||||
<listitem>
|
||||
<para>Enable embedded mode.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1 id="bugs">
|
||||
<title>Bugs</title>
|
||||
<para>Issues can be listed and reported at <ulink
|
||||
url="http://www.defora.org/os/project/bug_list/3305/Mixer"/>.</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->
|
||||
14
doc/project.conf
Normal file
14
doc/project.conf
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
targets=mixer.1,mixer.html
|
||||
dist=Makefile,docbook.sh,mixer.xml
|
||||
|
||||
[mixer.1]
|
||||
type=script
|
||||
script=./docbook.sh
|
||||
install=
|
||||
depends=mixer.xml
|
||||
|
||||
[mixer.html]
|
||||
type=script
|
||||
script=./docbook.sh
|
||||
install=
|
||||
depends=mixer.xml
|
||||
|
|
@ -2,5 +2,5 @@ package=Mixer
|
|||
version=0.1.1
|
||||
config=h,sh
|
||||
|
||||
subdirs=data,po,src
|
||||
subdirs=data,doc,po,src
|
||||
dist=COPYING,Makefile,config.h,config.sh
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user