From ebb2883297516ebba0b76d0f1bf06d6686483e6e Mon Sep 17 00:00:00 2001 From: Tanguy Ortolo Date: Fri, 28 Oct 2016 17:24:39 +0200 Subject: [PATCH] Add manpages for the utility scripts --- data/poezio_gpg_export.1 | 60 ++++++++++++++++++++++++++++++++ data/poezio_logs.1 | 74 ++++++++++++++++++++++++++++++++++++++++ setup.py | 4 ++- 3 files changed, 137 insertions(+), 1 deletion(-) create mode 100644 data/poezio_gpg_export.1 create mode 100644 data/poezio_logs.1 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 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" 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 +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" 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/setup.py b/setup.py index 25fc77b3..207ec1d3 100755 --- a/setup.py +++ b/setup.py @@ -98,7 +98,9 @@ setup(name="poezio", package_data={'poezio': ['default_config.cfg']}, scripts=['scripts/poezio_gpg_export', 'scripts/poezio_logs'], entry_points={'console_scripts': ['poezio = poezio.__main__:run']}, - data_files=([('share/man/man1/', ['data/poezio.1']), + data_files=([('share/man/man1/', ['data/poezio.1', + 'data/poezio_gpg_export.1', + 'data/poezio_logs.1']), ('share/poezio/', ['README.rst', 'COPYING', 'CHANGELOG'])] + find_doc('share/doc/poezio/source', 'source') + find_doc('share/doc/poezio/html', 'build/html')),