DeforaOS/Phone
DeforaOS/Phone
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added a manual page for the gprs(1) tool

Browse Source
This commit is contained in:
Pierre Pronchery 2014-08-29 04:38:43 +02:00
parent 9e7166e0f8
commit 5357cc031b
8 changed files with 137 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -73,6 +73,8 @@ dist:
$(PACKAGE)-$(VERSION)/doc/Makefile \
$(PACKAGE)-$(VERSION)/doc/docbook.sh \
$(PACKAGE)-$(VERSION)/doc/gprs.conf \
$(PACKAGE)-$(VERSION)/doc/gprs.css.xml \
$(PACKAGE)-$(VERSION)/doc/gprs.xml \
$(PACKAGE)-$(VERSION)/doc/index.xml \
$(PACKAGE)-$(VERSION)/doc/index.xsl \
$(PACKAGE)-$(VERSION)/doc/manual.css.xml \

16
doc/Makefile
View File

@ -1,7 +1,7 @@
MKDIR = mkdir -m 0755 -p
INSTALL = install
RM = rm -f
TARGETS = index.html phone.1 phone.html phonectl.1 phonectl.html
TARGETS = gprs.1 gprs.html index.html phone.1 phone.html phonectl.1 phonectl.html
PREFIX = /usr/local
DESTDIR =
RM = rm -f
@ -12,7 +12,13 @@ INSTALL = install
all: $(TARGETS)
index.html: index.xml index.xsl phone.xml phonectl.xml
gprs.1: gprs.xml
./docbook.sh -P "$(PREFIX)" -- "gprs.1"
gprs.html: manual.css.xml gprs.css.xml gprs.xml
./docbook.sh -P "$(PREFIX)" -- "gprs.html"
index.html: gprs.xml index.xml index.xsl phone.xml phonectl.xml
./docbook.sh -P "$(PREFIX)" -- "index.html"
phone.1: phone.xml
@ -28,13 +34,15 @@ phonectl.html: manual.css.xml phonectl.css.xml phonectl.xml
./docbook.sh -P "$(PREFIX)" -- "phonectl.html"
clean:
$(RM) -- $(index.html_OBJS) $(phone.1_OBJS) $(phone.html_OBJS) $(phonectl.1_OBJS) $(phonectl.html_OBJS)
$(RM) -- $(gprs.1_OBJS) $(gprs.html_OBJS) $(index.html_OBJS) $(phone.1_OBJS) $(phone.html_OBJS) $(phonectl.1_OBJS) $(phonectl.html_OBJS)
./docbook.sh -c -P "$(PREFIX)" -- "phonectl.html"
distclean: clean
$(RM) -- $(TARGETS)
install: $(TARGETS)
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "gprs.1"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "gprs.html"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "phone.1"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "phone.html"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "phonectl.1"
@ -49,6 +57,8 @@ install: $(TARGETS)
$(INSTALL) -m 0644 pppd-peers_phone $(DESTDIR)$(PREFIX)/share/doc/Phone/pppd-peers_phone
uninstall:
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "gprs.1"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "gprs.html"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "phone.1"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "phone.html"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "phonectl.1"

7
doc/gprs.css.xml Normal file
View 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: -->

88
doc/gprs.xml Normal file
View File

@ -0,0 +1,88 @@
<?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 "Phone User Manual">
<!ENTITY package "DeforaOS Phone">
<!ENTITY name "gprs">
<!ENTITY purpose "Desktop telephony application">
]>
<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; &lt;&email;&gt;</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>&section;</manvolnum>
</refmeta>
<refnamediv>
<refname>&name;</refname>
<refpurpose>&purpose;</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&name;</command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>Description</title>
<para><command>&name;</command> is a telephony application for desktop
environments and embedded devices. It allows connecting to Internet with the
<command>pppd<manvolnum>8</manvolnum></command> daemon.</para>
</refsect1>
<refsect1 id="options">
<title>Options</title>
<para><command>&name;</command> does not accept any options from the command
line.</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/3343/Phone"/>.</para>
</refsect1>
<refsect1 id="see_also">
<title>See also</title>
<para>
<citerefentry>
<refentrytitle>chat</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>phone</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>pppd</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>
<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->

2
doc/index.xml
View File

@ -7,6 +7,7 @@
<!ENTITY username "khorben">
<!ENTITY email "khorben@defora.org">
<!ENTITY package "DeforaOS Phone">
<!ENTITY gprs1 "gprs.xml">
<!ENTITY phone1 "phone.xml">
<!ENTITY phonectl1 "phonectl.xml">
]>
@ -42,6 +43,7 @@
<chapter>
<title>Manual pages</title>
<section>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="&gprs1;"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="&phone1;"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="&phonectl1;"/>
</section>

5
doc/phone.xml
View File

@ -28,6 +28,7 @@
</authorgroup>
<copyright>
<year>2013</year>
<year>2014</year>
<holder>&firstname; &surname; &lt;&email;&gt;</holder>
</copyright>
<legalnotice>
@ -88,6 +89,10 @@
<refsect1 id="see_also">
<title>See also</title>
<para>
<citerefentry>
<refentrytitle>gprs</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>phonectl</refentrytitle>
<manvolnum>1</manvolnum>

5
doc/phonectl.xml
View File

@ -28,6 +28,7 @@
</authorgroup>
<copyright>
<year>2013</year>
<year>2014</year>
<holder>&firstname; &surname; &lt;&email;&gt;</holder>
</copyright>
<legalnotice>
@ -129,6 +130,10 @@
<refsect1 id="see_also">
<title>See also</title>
<para>
<citerefentry>
<refentrytitle>gprs</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>phone</refentrytitle>
<manvolnum>1</manvolnum>

18
doc/project.conf
View File

@ -1,13 +1,25 @@
targets=index.html,phone.1,phone.html,phonectl.1,phonectl.html
dist=Makefile,docbook.sh,gprs.conf,index.xml,index.xsl,manual.css.xml,phone.css.xml,phone.xml,phonectl.css.xml,phonectl.xml,pppd-chat_gprs,pppd-ip-down,pppd-ip-up,pppd-peers_gprs,pppd-peers_phone
targets=gprs.1,gprs.html,index.html,phone.1,phone.html,phonectl.1,phonectl.html
dist=Makefile,docbook.sh,gprs.conf,gprs.css.xml,gprs.xml,index.xml,index.xsl,manual.css.xml,phone.css.xml,phone.xml,phonectl.css.xml,phonectl.xml,pppd-chat_gprs,pppd-ip-down,pppd-ip-up,pppd-peers_gprs,pppd-peers_phone
[gprs.1]
type=script
script=./docbook.sh
install=
depends=gprs.xml
[gprs.conf]
install=$(PREFIX)/share/doc/Phone
[gprs.html]
type=script
script=./docbook.sh
install=
depends=manual.css.xml,gprs.css.xml,gprs.xml
[index.html]
type=script
script=./docbook.sh
depends=index.xml,index.xsl,phone.xml,phonectl.xml
depends=gprs.xml,index.xml,index.xsl,phone.xml,phonectl.xml
[phone.1]
type=script