Browse Source

Don't generate man page from DocBook

Using DocBook to generate a single man page seems
overkill...
tags/v0.2.1^2
Damien Goutte-Gattat 7 years ago
parent
commit
5dcb6d5796
4 changed files with 74 additions and 204 deletions
  1. +0
    -5
      Makefile.am
  2. +73
    -0
      adfgvx.1.in
  3. +0
    -198
      adfgvx.xml.in
  4. +1
    -1
      configure.ac

+ 0
- 5
Makefile.am View File

@@ -3,11 +3,6 @@ SUBDIRS = lib src po
ACLOCAL_AMFLAGS = -I m4

man_MANS = adfgvx.1
EXTRA_DIST = $(top_srcdir)/adfgvx.xml.in adfgvx.xml $(man_MANS)

$(man_MANS): $(top_srcdir)/adfgvx.xml.in $(top_srcdir)/configure.ac
cd $(top_builddir) && $(SHELL) config.status adfgvx.xml
@xmlto man adfgvx.xml

dist_doc_DATA = AUTHORS \
COPYING \


+ 73
- 0
adfgvx.1.in View File

@@ -0,0 +1,73 @@
.TH ADFGVX 03/05/2013 "adfgvx @PACKAGE_VERSION@" "adfgvx Manual"

.SH NAME
adfgvx \- ADFGVX cipher

.SH SYNOPSIS
.SY adfgvx
.RB [ \-h | --help ]
.RB [ \-h | --version ]
.RB [ \-d | --decrypt ]
.RB [ \-e | --encrypt ]
.RB [ \-k | --key
.IR file ]
.RB [ \-o | --output
.IR file ]
.RB [ \-p | --pad64 ]
.RB [ \-s | --space ]
.RB [ \-g | --genkey ]
.I file
.YS

.SH DESCRIPTION
.PP
.B adfgvx
encrypts or decrypts a given file using the ADFGVX cipher.

.SH OPTIONS
.TP
.BR -h ", " --help
Display the help message.
.TP
.BR -v ", " --version
Display the version message.
.TP
.BR -d ", " --decrypt
Decrypt the given file (this is the default).
.TP
.BR -e ", " --encrypt
Encrypt the given file.
.TP
.BR -k ", " --key " " \fIfile\fR
Use the key in \fIfile\fR.
.TP
.BR -o ", " --output " " \fIfile\fR
Send output to
.I file
instead of standard output.
.TP
.BR -p ", " --pad64
When decrypting, pad the clear text with extra \*(Aq=\*(Aq characters.
.TP
.BR -s ", " --space
When encrypting, insert spaces between groups of five letters.
.TP
.BR -g ", " --genkey
Generate a new random key.

.SH REPORTING BUGS
.PP
Report bugs to
.MT @PACKAGE_BUGREPORT@
Damien Goutte-Gattat
.ME .

.SH COPYRIGHT
.ad l
.PP
Copyright \(co 2013 Damien Goutte\-Gattat
.PP
This program is released under the GNU General Public License.
See the COPYING file in the source distribution or
.UR http://www.gnu.org/licenses/gpl.html
.UE .

+ 0
- 198
adfgvx.xml.in View File

@@ -1,198 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">

<reference>

<referenceinfo>
<productname>@PACKAGE_NAME@ @PACKAGE_VERSION@</productname>
<authorgroup>
<author>
<firstname>Damien</firstname>
<surname>Goutte-Gattat</surname>
<affiliation>
<address>
<email>dgouttegattat@incenp.org</email>
</address>
</affiliation>
<contrib>Initial author</contrib>
</author>
</authorgroup>
</referenceinfo>

<title>@PACKAGE_NAME@ Manual</title>

<refentry id="adfgvx">

<refmeta>
<refentrytitle>adfgvx</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>

<refnamediv>
<refname>adfgvx</refname>
<refpurpose>ADFGVX cipher</refpurpose>
</refnamediv>

<refsynopsisdiv>
<cmdsynopsis>
<command>adfgvx</command>
<group>
<arg choice="plain">-h</arg>
<arg choice="plain">--help</arg>
</group>
<group>
<arg choice="plain">-v</arg>
<arg choice="plain">--version</arg>
</group>
<group>
<arg choice="plain">-d</arg>
<arg choice="plain">--decrypt</arg>
<arg choice="plain">-e</arg>
<arg choice="plain">--encrypt</arg>
</group>
<group>
<group choice="plain">
<arg choice="plain">-k</arg>
<arg choice="plain">--key</arg>
</group>
<replaceable>FILE</replaceable>
</group>
<group>
<group choice="plain">
<arg choice="plain">-o</arg>
<arg choice="plain">--output</arg>
</group>
<replaceable>FILE</replaceable>
</group>
<group>
<arg choice="plain">-p</arg>
<arg choice="plain">--pad64</arg>
</group>
<group>
<arg choice="plain">-s</arg>
<arg choice="plain">--space</arg>
</group>
<group>
<arg choice="plain">-g</arg>
<arg choice="plain">--genkey</arg>
</group>
<arg choice="plain">
<replaceable>FILE</replaceable>
</arg>
</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
<title>Description</title>

<para><application>adfgvx</application> encrypts or decrypts a given
file using the ADFGVX cipher.</para>

</refsect1>

<refsect1>
<title>Options</title>

<variablelist>

<varlistentry>
<term><option>-h</option></term>
<term><option>--help</option></term>
<listitem>
<para>Display the help message.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><option>-v</option></term>
<term><option>--version</option></term>
<listitem>
<para>Display the version message.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><option>-d</option></term>
<term><option>--decrypt</option></term>
<listitem>
<para>Decrypt the given file (this is the default).</para>
</listitem>
</varlistentry>

<varlistentry>
<term><option>-e</option></term>
<term><option>--encrypt</option></term>
<listitem>
<para>Encrypt the given file.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><option>-k</option></term>
<term><option>--key</option> <replaceable>FILE</replaceable></term>
<listitem>
<para>Use the key in <replaceable>FILE</replaceable>.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><option>-o</option></term>
<term><option>--output</option> <replaceable>FILE</replaceable></term>
<listitem>
<para>Send output to <replaceable>FILE</replaceable> instead of
standard output.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><option>-p</option></term>
<term><option>--pad64</option></term>
<listitem>
<para>When decrypting, pad the clear text with extra '='
characters.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><option>-s</option></term>
<term><option>--space</option></term>
<listitem>
<para>When encrypting, insert spaces between groups of five
letters.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><option>-g</option></term>
<term><option>--genkey</option></term>
<listitem>
<para>Generate a new random key.</para>
</listitem>
</varlistentry>

</variablelist>

</refsect1>

<refsect1>
<title>Reporting bugs</title>

<para>Report bugs to <email>@PACKAGE_BUGREPORT@</email>.</para>

</refsect1>

<refsect1>
<title>Copyright</title>

<para>Copyright © 2012 Damien Goutte-Gattat</para>

<para>This program is released under the GNU General Public License. See
the COPYING file in the source distribution or <ulink
url="http://www.gnu.org/licenses/gpl.html"/>.</para>

</refsect1>

</refentry>
</reference>

+ 1
- 1
configure.ac View File

@@ -46,7 +46,7 @@ AH_BOTTOM([#include <compat.h>
])

dnl Output files
AC_CONFIG_FILES([Makefile adfgvx.xml lib/Makefile src/Makefile
AC_CONFIG_FILES([Makefile adfgvx.1 lib/Makefile src/Makefile
po/Makefile.in])
AC_OUTPUT



Loading…
Cancel
Save