diff --git a/Makefile b/Makefile index 65d442b..78f9ed3 100644 --- a/Makefile +++ b/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 \ diff --git a/config.sh b/config.sh new file mode 100644 index 0000000..12480a4 --- /dev/null +++ b/config.sh @@ -0,0 +1,5 @@ +PACKAGE="Accessories" +VERSION="0.0.3" + +PREFIX="/usr/local" +LIBDIR="${PREFIX}/lib" diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..4d970ff --- /dev/null +++ b/doc/Makefile @@ -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 diff --git a/doc/docbook.sh b/doc/docbook.sh new file mode 100755 index 0000000..0caaa39 --- /dev/null +++ b/doc/docbook.sh @@ -0,0 +1,194 @@ +#!/bin/sh +#$Id$ +#Copyright (c) 2012-2014 Pierre Pronchery +# +#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 diff --git a/doc/manual.css.xml b/doc/manual.css.xml new file mode 100644 index 0000000..44af16b --- /dev/null +++ b/doc/manual.css.xml @@ -0,0 +1,33 @@ + + diff --git a/doc/progress.css.xml b/doc/progress.css.xml new file mode 100644 index 0000000..08d8dd3 --- /dev/null +++ b/doc/progress.css.xml @@ -0,0 +1,7 @@ + + + +]> + + diff --git a/doc/progress.xml b/doc/progress.xml new file mode 100644 index 0000000..9db50fb --- /dev/null +++ b/doc/progress.xml @@ -0,0 +1,156 @@ + + + + + + + + + + + +]> + + + &title; + &package; + + + &firstname; + &surname; + Code and documentation. +
+ &email; +
+ + + + 2014 + &firstname; &surname; <&email;> + + + This manual page was written for the DeforaOS Project (and may be + used by others). + 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. + + + + &name; + §ion; + + + &name; + &purpose; + + + + &name; + + + + + buffersize + + file + + length + + prefix + + title + command + args + + + + Description + &name; 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. + Additionally, it can be embedded within an existing window, like in the + notification area of a panel window. + + + Options + The following options are available: + + + + Enforce the size of the intermediate buffer. + + + + + Ignored for compatibility reasons. + + + + + + File to use for incoming data instead of the standard input. + + + + + + Specify or override the estimation of the data size. + + + + + + Text to display before the progress bar. + + + + + + Sets the title of the progress window. + + + + + + Uncompress the input on the fly using + gunzip1. + + + + 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. + + + Bugs + Issues can be listed and reported at . + + + See also + + + dd + 1 + , + + gunzip + 1 + , + + panel-embed + 1 + , + + tar + 1 + + + + + diff --git a/doc/project.conf b/doc/project.conf new file mode 100644 index 0000000..d388905 --- /dev/null +++ b/doc/project.conf @@ -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 diff --git a/project.conf b/project.conf index 36030d6..08b8323 100644 --- a/project.conf +++ b/project.conf @@ -1,5 +1,6 @@ package=Accessories version=0.0.3 +config=sh -subdirs=src +subdirs=doc,src dist=Makefile,COPYING