File: jumpapplet.1.xml

package info (click to toggle)
autojump 20-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 336 kB
  • sloc: python: 482; sh: 363; xml: 81; makefile: 10
file content (120 lines) | stat: -rw-r--r-- 4,199 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V5.0//EN" "http://docbook.org/xml/5.0/dtd/docbook.dtd" [

<!--

`xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl-ns/manpages/docbook.xsl \
          jumpapplet.1.xml'

A manual page jumpapplet.1 will be generated. You may view the
manual page with: man -l jumpapplet.1'. A typical entry in a Makefile or
Makefile.am is:

DB2MAN = /usr/share/xml/docbook/stylesheet/docbook-xsl-ns/manpages/docbook.xsl
XP     = xsltproc

jumpapplet.1: jumpapplet.1.xml
        $(XP) $(DB2MAN) $<

The xsltproc binary is found in the xsltproc package. The XSL files are in
docbook-xsl-ns. A description of the parameters you can use can be found in the
docbook-xsl-doc-* packages.

Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`

General documentation about man-pages and man-page-formatting:
man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/

-->

  <!ENTITY authorfirstname "Tanguy">
  <!ENTITY authorsurname   "Ortolo">
  <!ENTITY authorfullname  "&authorfirstname; &authorsurname;">
  <!ENTITY authoremail     "tanguy+debian@ortolo.eu">
  <!ENTITY mansection      "1">
  <!ENTITY mansectitle     "User Commands">
  <!ENTITY upcommand       "JUMPAPPLET">
  <!ENTITY command         "jumpapplet">
  <!ENTITY program         "jumpapplet">
]>

<article xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:lang="en">
<title>User commands</title>
<refentry xml:id="&command;">
  <info>
    <productname>&program;</productname>

    <authorgroup>
      <author>
        <personname><firstname>&authorfirstname;</firstname><surname>&authorsurname;</surname></personname>
        <contrib>Wrote this manpage for the Debian system.</contrib>
        <address><email>&authoremail;</email></address>
      </author>
    </authorgroup>

    <copyright>
      <year>2010</year>
      <holder>&authorfullname;</holder>
    </copyright>

    <legalnotice>
      <para>This manual page was written for the Debian system
        (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 or (at your option) any later version published by
        the Free Software Foundation.</para>
      <para>On Debian systems, the complete text of the GNU General Public
        License can be found in
        <filename>/usr/share/common-licenses/GPL</filename>.</para>
    </legalnotice>
  </info>

  <refmeta>
    <refentrytitle>&upcommand;</refentrytitle>
    <manvolnum>&mansection;</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>&command;</refname>
    <refpurpose>notification icon for autojump</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
        <command>&command;</command>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsection xml:id="description"><info><title>DESCRIPTION</title></info>
    <para>This manual page documents briefly the
      <command>&command;</command> command. It was written for the Debian
      distribution because the original program does not have a manual
      page.</para>
    <para><application>&program;</application> is an applet that provides a
      notification icon based on
      <citerefentry><refentrytitle>autojump</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
  </refsection>

  <refsection xml:id="options"><info><title>OPTIONS</title></info>
      <para>This program has no options</para>
  </refsection>

  <refsection xml:id="files"><info><title>FILES</title></info>
    <variablelist>
      <varlistentry>
        <term><filename>~/.jumpapplet.py</filename></term>
        <listitem><para>Configuration file for <application>&program;</application>
        </para></listitem>
      </varlistentry>
    </variablelist>
  </refsection>

  <refsection xml:id="bugs"><info><title>BUGS</title></info>
    <para><application>&program;</application> uses a configuration file in a
      format that is not really human-friendly. Thus, it should be configured
      by using its graphical interface.</para>
  </refsection>

</refentry>
</article>