Imported a manual page for progress(1)
This commit is contained in:
parent
25e1b4059c
commit
a5b3488587
8
Makefile
8
Makefile
|
|
@ -1,6 +1,6 @@
|
|||
PACKAGE = Accessories
|
||||
VERSION = 0.0.3
|
||||
SUBDIRS = src
|
||||
SUBDIRS = doc src
|
||||
RM = rm -f
|
||||
LN = ln -f
|
||||
TAR = tar -czvf
|
||||
|
|
@ -21,6 +21,12 @@ dist:
|
|||
$(RM) -r -- $(PACKAGE)-$(VERSION)
|
||||
$(LN) -s -- . $(PACKAGE)-$(VERSION)
|
||||
@$(TAR) $(PACKAGE)-$(VERSION).tar.gz -- \
|
||||
$(PACKAGE)-$(VERSION)/doc/Makefile \
|
||||
$(PACKAGE)-$(VERSION)/doc/docbook.sh \
|
||||
$(PACKAGE)-$(VERSION)/doc/progress.css.xml \
|
||||
$(PACKAGE)-$(VERSION)/doc/progress.xml \
|
||||
$(PACKAGE)-$(VERSION)/doc/manual.css.xml \
|
||||
$(PACKAGE)-$(VERSION)/doc/project.conf \
|
||||
$(PACKAGE)-$(VERSION)/src/compare.c \
|
||||
$(PACKAGE)-$(VERSION)/src/fontsel.c \
|
||||
$(PACKAGE)-$(VERSION)/src/progress.c \
|
||||
|
|
|
|||
5
config.sh
Normal file
5
config.sh
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
PACKAGE="Accessories"
|
||||
VERSION="0.0.3"
|
||||
|
||||
PREFIX="/usr/local"
|
||||
LIBDIR="${PREFIX}/lib"
|
||||
33
doc/Makefile
Normal file
33
doc/Makefile
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
TARGETS = progress.1 progress.html
|
||||
PREFIX = /usr/local
|
||||
DESTDIR =
|
||||
RM = rm -f
|
||||
LN = ln -f
|
||||
MKDIR = mkdir -m 0755 -p
|
||||
INSTALL = install
|
||||
|
||||
|
||||
all: $(TARGETS)
|
||||
|
||||
progress.1: progress.xml
|
||||
./docbook.sh -P "$(PREFIX)" -- "progress.1"
|
||||
|
||||
progress.html: progress.css.xml progress.xml manual.css.xml
|
||||
./docbook.sh -P "$(PREFIX)" -- "progress.html"
|
||||
|
||||
clean:
|
||||
$(RM) -- $(progress.1_OBJS) $(progress.html_OBJS)
|
||||
./docbook.sh -c -P "$(PREFIX)" -- "progress.html"
|
||||
|
||||
distclean: clean
|
||||
$(RM) -- $(TARGETS)
|
||||
|
||||
install: $(TARGETS)
|
||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "progress.1"
|
||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "progress.html"
|
||||
|
||||
uninstall:
|
||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "progress.1"
|
||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "progress.html"
|
||||
|
||||
.PHONY: all clean distclean install uninstall
|
||||
194
doc/docbook.sh
Executable file
194
doc/docbook.sh
Executable file
|
|
@ -0,0 +1,194 @@
|
|||
#!/bin/sh
|
||||
#$Id$
|
||||
#Copyright (c) 2012-2014 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"
|
||||
[ -f "../config.sh" ] && . "../config.sh"
|
||||
#executables
|
||||
DEBUG="_debug"
|
||||
FOP="fop"
|
||||
INSTALL="install -m 0644"
|
||||
MKDIR="mkdir -m 0755 -p"
|
||||
RM="rm -f"
|
||||
XMLLINT="xmllint"
|
||||
XSLTPROC="xsltproc --nonet --xinclude"
|
||||
|
||||
|
||||
#functions
|
||||
#debug
|
||||
_debug()
|
||||
{
|
||||
echo "$@" 1>&2
|
||||
"$@"
|
||||
}
|
||||
|
||||
|
||||
#docbook
|
||||
_docbook()
|
||||
{
|
||||
target="$1"
|
||||
|
||||
source="${target%.*}.xml"
|
||||
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"
|
||||
[ -f "${target%.*}.css.xml" ] && XSLTPROC="$XSLTPROC --param custom.css.source \"${target%.*}.css.xml\" --param generate.css.header 1"
|
||||
$DEBUG $XSLTPROC -o "$target" "$XSL" "$source"
|
||||
;;
|
||||
pdf)
|
||||
XSL="http://docbook.sourceforge.net/release/xsl/current/fo/docbook.xsl"
|
||||
[ -f "${target%.*}.xsl" ] && XSL="${target%.*}.xsl"
|
||||
$DEBUG $XSLTPROC -o "${target%.*}.fo" "$XSL" "$source" &&
|
||||
$DEBUG $FOP -fo "${target%.*}.fo" -pdf "$target"
|
||||
$RM -- "${target%.*}.fo"
|
||||
;;
|
||||
1|2|3|4|5|6|7|8|9)
|
||||
XSL="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"
|
||||
$DEBUG $XSLTPROC -o "$target" "$XSL" "$source"
|
||||
;;
|
||||
*)
|
||||
echo "$0: $target: Unknown type" 1>&2
|
||||
return 2
|
||||
;;
|
||||
esac
|
||||
|
||||
if [ $? -ne 0 ]; then
|
||||
echo "$0: $target: Could not create page" 1>&2
|
||||
$RM -- "$target"
|
||||
return 2
|
||||
fi
|
||||
}
|
||||
|
||||
|
||||
#error
|
||||
_error()
|
||||
{
|
||||
echo "docbook.sh: $@" 1>&2
|
||||
return 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="$OPTARG"
|
||||
;;
|
||||
?)
|
||||
_usage
|
||||
exit $?
|
||||
;;
|
||||
esac
|
||||
done
|
||||
shift $((OPTIND - 1))
|
||||
if [ $# -eq 0 ]; then
|
||||
_usage
|
||||
exit $?
|
||||
fi
|
||||
|
||||
#check the variables
|
||||
if [ -z "$PACKAGE" ]; then
|
||||
_error "The PACKAGE variable needs to be set"
|
||||
exit $?
|
||||
fi
|
||||
|
||||
[ -z "$DATADIR" ] && DATADIR="$PREFIX/share"
|
||||
[ -z "$MANDIR" ] && MANDIR="$DATADIR/man"
|
||||
|
||||
while [ $# -gt 0 ]; do
|
||||
target="$1"
|
||||
shift
|
||||
|
||||
#determine the type
|
||||
ext="${target##*.}"
|
||||
ext="${ext##.}"
|
||||
case "$ext" in
|
||||
html)
|
||||
instdir="$DATADIR/doc/$ext/$PACKAGE"
|
||||
source="${target%.*}.xml"
|
||||
xpath="string(/refentry/refmeta/manvolnum)"
|
||||
section=$($XMLLINT --xpath "$xpath" "$source")
|
||||
if [ $? -eq 0 -a -n "$section" ]; then
|
||||
instdir="$DATADIR/man/html$section"
|
||||
fi
|
||||
;;
|
||||
pdf)
|
||||
instdir="$DATADIR/doc/$ext/$PACKAGE"
|
||||
;;
|
||||
1|2|3|4|5|6|7|8|9)
|
||||
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
|
||||
#XXX ignore errors
|
||||
_docbook "$target" || break
|
||||
done
|
||||
33
doc/manual.css.xml
Normal file
33
doc/manual.css.xml
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
<?xml version="1.0"?>
|
||||
<style><![CDATA[/* $Id$ */
|
||||
|
||||
div.refentry {
|
||||
font-family: monospace;
|
||||
margin-left: 5ex;
|
||||
min-width: 102ex;
|
||||
width: 102ex;
|
||||
}
|
||||
|
||||
div.refentry h1, div.refentry h2, div.refentry h3 {
|
||||
font-size: inherit;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.refentry h1, div.refentry h2 {
|
||||
margin-left: -4ex;
|
||||
text-transform: uppercase;
|
||||
}
|
||||
|
||||
div.refentry h3 {
|
||||
margin-left: -2ex;
|
||||
}
|
||||
|
||||
div.refentry p {
|
||||
margin-top: 0;
|
||||
padding-top: 0;
|
||||
}
|
||||
|
||||
div.refentry blockquote, div.refentry pre {
|
||||
margin-left: 5ex;
|
||||
}
|
||||
]]></style>
|
||||
7
doc/progress.css.xml
Normal file
7
doc/progress.css.xml
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
<?xml version="1.0"?>
|
||||
<!-- $Id$ -->
|
||||
<!DOCTYPE style [
|
||||
<!ENTITY manual "manual.css.xml">
|
||||
]>
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="&manual;"/>
|
||||
<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->
|
||||
156
doc/progress.xml
Normal file
156
doc/progress.xml
Normal file
|
|
@ -0,0 +1,156 @@
|
|||
<?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 "Accessories User Manual">
|
||||
<!ENTITY package "DeforaOS Accessories">
|
||||
<!ENTITY name "progress">
|
||||
<!ENTITY purpose "Generic progress bar utility">
|
||||
]>
|
||||
<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>2014</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>
|
||||
<arg choice="opt"><option>-x</option></arg>
|
||||
<arg choice="opt"><option>-e</option></arg>
|
||||
<arg choice="opt"><option>-z</option></arg>
|
||||
<arg choice="opt"><option>-b</option>
|
||||
<replaceable>buffersize</replaceable></arg>
|
||||
<arg choice="opt"><option>-f</option>
|
||||
<replaceable>file</replaceable></arg>
|
||||
<arg choice="opt"><option>-l</option>
|
||||
<replaceable>length</replaceable></arg>
|
||||
<arg choice="opt"><option>-p</option>
|
||||
<replaceable>prefix</replaceable></arg>
|
||||
<arg choice="opt"><option>-t</option>
|
||||
<replaceable>title</replaceable></arg>
|
||||
<arg choice="plain"><replaceable>command</replaceable></arg>
|
||||
<arg rep="repeat"><replaceable>args</replaceable></arg>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
<refsect1 id="description">
|
||||
<title>Description</title>
|
||||
<para><command>&name;</command> can be used to report on the progress of
|
||||
Input/Output (I/O) operations, like when manipulating files and
|
||||
devices. It expects data either from the standard input or from a file, and
|
||||
forwards it over to a separate process through the standard input
|
||||
again. It reports continuously on data throughput while doing so.</para>
|
||||
<para>Additionally, it can be embedded within an existing window, like in the
|
||||
notification area of a panel window.</para>
|
||||
</refsect1>
|
||||
<refsect1 id="options">
|
||||
<title>Options</title>
|
||||
<para>The following options are available:</para>
|
||||
<variablelist>
|
||||
<term><option>-b</option></term>
|
||||
<listitem>
|
||||
<para>Enforce the size of the intermediate buffer.</para>
|
||||
</listitem>
|
||||
<varlistentry>
|
||||
<term><option>-e</option></term>
|
||||
<listitem>
|
||||
<para>Ignored for compatibility reasons.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-f</option></term>
|
||||
<listitem>
|
||||
<para>File to use for incoming data instead of the standard input.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-l</option></term>
|
||||
<listitem>
|
||||
<para>Specify or override the estimation of the data size.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-p</option></term>
|
||||
<listitem>
|
||||
<para>Text to display before the progress bar.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-t</option></term>
|
||||
<listitem>
|
||||
<para>Sets the title of the progress window.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-z</option></term>
|
||||
<listitem>
|
||||
<para>Uncompress the input on the fly using
|
||||
<command>gunzip<manvolnum>1</manvolnum></command>.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<para>A command to execute must be provided on the command line, with an
|
||||
arbitrary number of arguments. It is then executed, with the incoming data
|
||||
forwarded to this sub-process over the standard input.</para>
|
||||
</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/235/Accessories"/>.</para>
|
||||
</refsect1>
|
||||
<refsect1 id="see_also">
|
||||
<title>See also</title>
|
||||
<para>
|
||||
<citerefentry>
|
||||
<refentrytitle>dd</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
</citerefentry>,
|
||||
<citerefentry>
|
||||
<refentrytitle>gunzip</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
</citerefentry>,
|
||||
<citerefentry>
|
||||
<refentrytitle>panel-embed</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
</citerefentry>,
|
||||
<citerefentry>
|
||||
<refentrytitle>tar</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
</citerefentry>
|
||||
</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=progress.1,progress.html
|
||||
dist=Makefile,docbook.sh,progress.css.xml,progress.xml,manual.css.xml
|
||||
|
||||
[progress.1]
|
||||
type=script
|
||||
script=./docbook.sh
|
||||
install=
|
||||
depends=progress.xml
|
||||
|
||||
[progress.html]
|
||||
type=script
|
||||
script=./docbook.sh
|
||||
install=
|
||||
depends=progress.css.xml,progress.xml,manual.css.xml
|
||||
|
|
@ -1,5 +1,6 @@
|
|||
package=Accessories
|
||||
version=0.0.3
|
||||
config=sh
|
||||
|
||||
subdirs=src
|
||||
subdirs=doc,src
|
||||
dist=Makefile,COPYING
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user