From 48cfb49acbfbe9c1803c4d3fb2f1775b440b0dd2 Mon Sep 17 00:00:00 2001 From: Bastian Venthur Date: Thu, 9 Jun 2022 22:22:03 +0200 Subject: [PATCH] generate man page in debian package --- debian/README.Debian | 6 --- debian/manpage.1.ex | 56 ------------------- debian/manpage.md.ex | 126 ------------------------------------------- debian/rules | 4 +- 4 files changed, 2 insertions(+), 190 deletions(-) delete mode 100644 debian/README.Debian delete mode 100644 debian/manpage.1.ex delete mode 100644 debian/manpage.md.ex diff --git a/debian/README.Debian b/debian/README.Debian deleted file mode 100644 index 25ce732..0000000 --- a/debian/README.Debian +++ /dev/null @@ -1,6 +0,0 @@ -blag for Debian --------------- - - - - -- Bastian Venthur Sun, 05 Jun 2022 15:20:48 +0200 diff --git a/debian/manpage.1.ex b/debian/manpage.1.ex deleted file mode 100644 index c2dbdcc..0000000 --- a/debian/manpage.1.ex +++ /dev/null @@ -1,56 +0,0 @@ -.\" Hey, EMACS: -*- nroff -*- -.\" (C) Copyright 2022 Bastian Venthur , -.\" -.\" First parameter, NAME, should be all caps -.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection -.\" other parameters are allowed: see man(7), man(1) -.TH Blag SECTION "June 5 2022" -.\" Please adjust this date whenever revising the manpage. -.\" -.\" Some roff macros, for reference: -.\" .nh disable hyphenation -.\" .hy enable hyphenation -.\" .ad l left justify -.\" .ad b justify to both left and right margins -.\" .nf disable filling -.\" .fi enable filling -.\" .br insert line break -.\" .sp insert n+1 empty lines -.\" for manpage-specific macros, see man(7) -.SH NAME -blag \- program to do something -.SH SYNOPSIS -.B blag -.RI [ options ] " files" ... -.br -.B bar -.RI [ options ] " files" ... -.SH DESCRIPTION -This manual page documents briefly the -.B blag -and -.B bar -commands. -.PP -.\" TeX users may be more comfortable with the \fB\fP and -.\" \fI\fP escape sequences to invode bold face and italics, -.\" respectively. -\fBblag\fP is a program that... -.SH OPTIONS -These programs follow the usual GNU command line syntax, with long -options starting with two dashes ('-'). -A summary of options is included below. -For a complete description, see the Info files. -.TP -.B \-h, \-\-help -Show summary of options. -.TP -.B \-v, \-\-version -Show version of program. -.SH SEE ALSO -.BR bar (1), -.BR baz (1). -.br -The programs are documented fully by -.IR "The Rise and Fall of a Fooish Bar" , -available via the Info system. diff --git a/debian/manpage.md.ex b/debian/manpage.md.ex deleted file mode 100644 index 6b008b9..0000000 --- a/debian/manpage.md.ex +++ /dev/null @@ -1,126 +0,0 @@ -% blag(SECTION) | User Commands -% -% "June 5 2022" - -[comment]: # The lines above form a Pandoc metadata block. They must be -[comment]: # the first ones in the file. -[comment]: # See https://pandoc.org/MANUAL.html#metadata-blocks for details. - -[comment]: # pandoc -s -f markdown -t man package.md -o package.1 -[comment]: # -[comment]: # A manual page package.1 will be generated. You may view the -[comment]: # manual page with: nroff -man package.1 | less. A typical entry -[comment]: # in a Makefile or Makefile.am is: -[comment]: # -[comment]: # package.1: package.md -[comment]: # pandoc --standalone --from=markdown --to=man $< --output=$@ -[comment]: # -[comment]: # The pandoc binary is found in the pandoc package. Please remember -[comment]: # that if you create the nroff version in one of the debian/rules -[comment]: # file targets, such as build, you will need to include pandoc in -[comment]: # your Build-Depends control field. - -[comment]: # Remove the lines starting with '[comment]:' in this file in order -[comment]: # to avoid warning messages from pandoc. - -# NAME - -blag - program to do something - -# SYNOPSIS - -**blag** **-e** _this_ [**\-\-example=that**] [{**-e** | **\-\-example**} _this_] - [{**-e** | **\-\-example**} {_this_ | _that_}] - -**blag** [{**-h** | *\-\-help**} | {**-v** | **\-\-version**}] - -# DESCRIPTION - -This manual page documents briefly the **blag** and **bar** commands. - -This manual page was written for the Debian distribution because the -original program does not have a manual page. Instead, it has documentation -in the GNU info(1) format; see below. - -**blag** is a program that... - -# OPTIONS - -The program follows the usual GNU command line syntax, with long options -starting with two dashes ('-'). A summary of options is included below. For -a complete description, see the **info**(1) files. - -**-e** _this_, **\-\-example=**_that_ -: Does this and that. - -**-h**, **\-\-help** -: Show summary of options. - -**-v**, **\-\-version** -: Show version of program. - -# FILES - -/etc/foo.conf -: The system-wide configuration file to control the behaviour of - blag. See **foo.conf**(5) for further details. - -${HOME}/.foo.conf -: The per-user configuration file to control the behaviour of - blag. See **foo.conf**(5) for further details. - -# ENVIRONMENT - -**FOO_CONF** -: If used, the defined file is used as configuration file (see also - the section called “FILES”). - -# DIAGNOSTICS - -The following diagnostics may be issued on stderr: - -Bad configuration file. Exiting. -: The configuration file seems to contain a broken configuration - line. Use the **\-\-verbose** option, to get more info. - -**blag** provides some return codes, that can be used in scripts: - - Code Diagnostic - 0 Program exited successfully. - 1 The configuration file seems to be broken. - -# BUGS - -The program is currently limited to only work with the foobar library. - -The upstream BTS can be found at http://bugzilla.foo.tld. - -# SEE ALSO - -**bar**(1), **baz**(1), **foo.conf**(5) - -The programs are documented fully by The Rise and Fall of a Fooish Bar -available via the **info**(1) system. - -# AUTHOR - -Bastian Venthur -: Wrote this manpage for the Debian system. - -# COPYRIGHT - -Copyright © 2007 Bastian Venthur - -This manual page was written for the Debian system (and may be used by -others). - -Permission is granted to copy, distribute and/or modify this document under -the terms of the GNU General Public License, Version 2 or (at your option) -any later version published by the Free Software Foundation. - -On Debian systems, the complete text of the GNU General Public License -can be found in /usr/share/common-licenses/GPL. - -[comment]: # Local Variables: -[comment]: # mode: markdown -[comment]: # End: diff --git a/debian/rules b/debian/rules index 6596836..d61e888 100755 --- a/debian/rules +++ b/debian/rules @@ -21,5 +21,5 @@ execute_after_dh_auto_build-indep: export https_proxy=127.0.0.1:9 execute_after_dh_auto_build-indep: PYTHONPATH=. python3 -m sphinx -N -bhtml \ docs/ build/html # HTML generator -# PYTHONPATH=. python3 -m sphinx -N -bman \ -# docs/ build/man # Manpage generator + PYTHONPATH=. python3 -m sphinx -N -bman \ + docs/ build/man # Manpage generator