diff options
Diffstat (limited to 'data')
-rw-r--r-- | data/default_config.cfg | 2 | ||||
-rw-r--r-- | data/poezio.1 | 2 | ||||
-rw-r--r-- | data/poezio_80.png | bin | 6739 -> 6211 bytes | |||
-rw-r--r-- | data/poezio_gpg_export.1 | 60 | ||||
-rw-r--r-- | data/poezio_logs.1 | 74 | ||||
-rw-r--r-- | data/scripts-manpages.xml | 155 |
6 files changed, 291 insertions, 2 deletions
diff --git a/data/default_config.cfg b/data/default_config.cfg index 689fd4a6..96472f49 100644 --- a/data/default_config.cfg +++ b/data/default_config.cfg @@ -34,7 +34,7 @@ certfile = keyfile = # the nick you will use when joining a room with no associated nick -# If this is empty, the $USER environnement variable will be used +# If this is empty, the $USER environment variable will be used default_nick = # the rooms you will join automatically on startup, with associated nickname or not diff --git a/data/poezio.1 b/data/poezio.1 index 539db39e..d54e991c 100644 --- a/data/poezio.1 +++ b/data/poezio.1 @@ -16,7 +16,7 @@ is a console jabber (XMPP) client written in Python and using ncurses to draw it Run poezio using \fICONFIG_FILE\fR as the config file instead of ~/.config/poezio/poezio.cfg .TP \fB\-d\fR, \fB\-\-debug \fIDEBUG_FILE\fR -Log debug from both poezio and SleekXMPP in \fIDEBUG_FILE\fR. Debug contains incoming and outgoing stanzas in addition to various message helping poezio's debuging. +Log debug from both poezio and SleekXMPP in \fIDEBUG_FILE\fR. Debug contains incoming and outgoing stanzas in addition to various message helping poezio's debugging. .TP \fB\-h\fR Display an help message diff --git a/data/poezio_80.png b/data/poezio_80.png Binary files differindex e56c6128..f5d7f12c 100644 --- a/data/poezio_80.png +++ b/data/poezio_80.png diff --git a/data/poezio_gpg_export.1 b/data/poezio_gpg_export.1 new file mode 100644 index 00000000..0d163440 --- /dev/null +++ b/data/poezio_gpg_export.1 @@ -0,0 +1,60 @@ +'\" t +.\" Title: POEZIO_GPG_EXPORT +.\" Author: Tanguy Ortolo <tanguy+debian@ortolo.eu> +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 10/28/2016 +.\" Manual: User commands +.\" Source: Poezio +.\" Language: English +.\" +.TH "POEZIO_GPG_EXPORT" "1" "10/28/2016" "Poezio" "User commands" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +poezio_gpg_export \- Print a key list for the Poezio GPG plugin +.SH "SYNOPSIS" +.HP \w'\fBpoezio_gpg_export\fR\ 'u +\fBpoezio_gpg_export\fR +.SH "DESCRIPTION" +.PP +Poezio +is a console\-based XMPP client\&. +.PP +\fBpoezio_gpg_export\fR +uses +\fBgpg\fR +to build a list suitable for the Poezio GPG plugin\&. Double\-check the output and use at your own risk\&. +.SH "SEE ALSO" +\fBpoezio\fR(1), \fBgpg\fR(1) +.SH "AUTHOR" +.PP +\fBTanguy Ortolo\fR <\&tanguy+debian@ortolo.eu\&> +.RS 4 +Wrote this manpage for the Debian system. +.RE +.SH "COPYRIGHT" +.br +Copyright \(co 2016 Tanguy Ortolo +.br +.PP +This manual page was written for the Debian system (and may be used by others). +.PP +Permission is granted to copy, distribute and/or modify this document under the terms of the Zlib License. +.sp diff --git a/data/poezio_logs.1 b/data/poezio_logs.1 new file mode 100644 index 00000000..0be422aa --- /dev/null +++ b/data/poezio_logs.1 @@ -0,0 +1,74 @@ +'\" t +.\" Title: POEZIO_LOGS +.\" Author: Tanguy Ortolo <tanguy+debian@ortolo.eu> +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 10/28/2016 +.\" Manual: User commands +.\" Source: Poezio +.\" Language: English +.\" +.TH "POEZIO_LOGS" "1" "10/28/2016" "Poezio" "User commands" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +poezio_logs \- Display a Poezio log in a human\-readable format +.SH "SYNOPSIS" +.HP \w'\fBpoezio_logs\fR\ 'u +\fBpoezio_logs\fR [\fIoptions\fR] {\fILOG_FILE\fR} +.SH "DESCRIPTION" +.PP +Poezio +is a console\-based XMPP client\&. +.PP +\fBpoezio_logs\fR +displays a log stored in Poezio format in a more human\-readable way\&. +.SH "OPTIONS" +.PP +\fB\-i\fR, \fB\-\-hide\-info\fR +.RS 4 +Hide info lines +.RE +.PP +\fB\-t\fR, \fB\-\-hide\-time\fR +.RS 4 +Hide timestamps +.RE +.PP +\fB\-c\fR, \fB\-\-no\-color\fR +.RS 4 +Remove color +.RE +.SH "SEE ALSO" +\fBpoezio\fR(1) +.SH "AUTHOR" +.PP +\fBTanguy Ortolo\fR <\&tanguy+debian@ortolo.eu\&> +.RS 4 +Wrote this manpage for the Debian system. +.RE +.SH "COPYRIGHT" +.br +Copyright \(co 2016 Tanguy Ortolo +.br +.PP +This manual page was written for the Debian system (and may be used by others). +.PP +Permission is granted to copy, distribute and/or modify this document under the terms of the Zlib License. +.sp diff --git a/data/scripts-manpages.xml b/data/scripts-manpages.xml new file mode 100644 index 00000000..241ba6ea --- /dev/null +++ b/data/scripts-manpages.xml @@ -0,0 +1,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> |