summaryrefslogtreecommitdiff
path: root/data/scripts-manpages.xml
blob: 241ba6eaedac21b25742a7aacdb270f44ea51b3b (plain)
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
<?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 \
          scripts.xml'

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

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

poezio_gpg_export.1 poezio_logs.1: scripts.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 upcommand1      "POEZIO_GPG_EXPORT">
  <!ENTITY command1        "poezio_gpg_export">
  <!ENTITY upcommand2      "POEZIO_LOGS">
  <!ENTITY command2        "poezio_logs">
  <!ENTITY program         "Poezio">
]>

<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>
<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>2016</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 Zlib License.</para>
</legalnotice>
</info>

<refentry xml:id="&command1;">
  <refmeta>
    <refentrytitle>&upcommand1;</refentrytitle>
    <manvolnum>&mansection;</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>&command1;</refname>
    <refpurpose>Print a key list for the &program; GPG plugin</refpurpose>
  </refnamediv>

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

  <refsection xml:id="poezio_gpg_export-description"><info><title>DESCRIPTION</title></info>
    <para><application>&program;</application> is a console-based XMPP
      client.</para>
    <para><command>&command1;</command> uses <command>gpg</command> to build
      a list suitable for the &program; GPG plugin. Double-check the output
      and use at your own risk.</para>
  </refsection>

  <refsection xml:id="poezio_gpg_export-see"><info><title>SEE ALSO</title></info>
    <simplelist type="inline">
      <member><citerefentry><refentrytitle>poezio</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>gpg</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
    </simplelist>
  </refsection>
</refentry>

<refentry xml:id="&command2;">
  <refmeta>
    <refentrytitle>&upcommand2;</refentrytitle>
    <manvolnum>&mansection;</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>&command2;</refname>
    <refpurpose>Display a Poezio log in a human-readable format</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&command2;</command>
      <arg choice="opt"><replaceable>options</replaceable></arg>
      <arg choice="req"><replaceable>LOG_FILE</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsection xml:id="poezio_logs-description"><info><title>DESCRIPTION</title></info>
    <para><application>&program;</application> is a console-based XMPP
      client.</para>
    <para><command>&command2;</command> displays a log stored in Poezio format
      in a more human-readable way.</para>
  </refsection>

  <refsection xml:id="poezio_logs-options"><info><title>OPTIONS</title></info>
    <variablelist>
      <varlistentry>
        <term><option>-i</option></term>
        <term><option>--hide-info</option></term>
        <listitem><para>Hide info lines</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-t</option></term>
        <term><option>--hide-time</option></term>
        <listitem><para>Hide timestamps</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-c</option></term>
        <term><option>--no-color</option></term>
        <listitem><para>Remove color</para></listitem>
      </varlistentry>
    </variablelist>
  </refsection>

  <refsection xml:id="poezio_logs-see"><info><title>SEE ALSO</title></info>
    <simplelist type="inline">
      <member><citerefentry><refentrytitle>poezio</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
    </simplelist>
  </refsection>
</refentry>

</article>