[Reproducible-commits] [txt2man] 03/13: deleted

Reiner Herrmann reiner at reiner-h.de
Thu Jul 2 16:52:19 UTC 2015


This is an automated email from the git hooks/post-receive script.

deki-guest pushed a commit to branch pu/reproducible_builds
in repository txt2man.

commit 1af8c1d375da6bfffdfccbd753ffa1a6f8e9eb29
Author: Fredrik Steen <stone at debian.org>
Date:   Thu Apr 7 16:03:08 2011 +0200

    deleted
---
 bookman.1 |  79 -----------------------------
 src2man.1 |  85 -------------------------------
 txt2man.1 | 168 --------------------------------------------------------------
 3 files changed, 332 deletions(-)

diff --git a/bookman.1 b/bookman.1
deleted file mode 100644
index 296bb7a..0000000
--- a/bookman.1
+++ /dev/null
@@ -1,79 +0,0 @@
-." Text automatically generated by txt2man
-.TH bookman 1 "21 March 2007" "txt2man-1.5.5" ""
-.SH NAME
-\fBbookman \fP- Generate a book from man pages
-.SH SYNOPSIS
-.nf
-.fam C
-\fBbookman\fP [\fB-pPxn\fP] [\fB-o\fP \fIoutfile\fP] [\fB-a\fP \fIauthor\fP] [\fB-d\fP \fIdate\fP] [\fB-r\fP \fIrelease\fP]
-[\fB-t\fP \fItitle\fP] [\fB-v\fP \fIvolume\fP] [\fB-c\fP \fIcoverfile\fP] [\fImanfile\fP]
-.fam T
-.fi
-.fam T
-.fi
-.SH DESCRIPTION
-\fBbookman\fP compiles a set of man pages files specified by \fImanfile\fP
-arguments, or if no \fImanfile\fP is given, filenames are read from standard
-input.
-.SH OPTIONS
-.TP
-.B
-\fB-p\fP
-PDF output format.
-.TP
-.B
-\fB-P\fP
-Postscript output format.
-.TP
-.B
-\fB-x\fP
-X11 previewing, using \fBgxditview\fP(1).
-.TP
-.B
-\fB-n\fP
-no format, output is direct gtroff intermediate format.
-.TP
-.B
-\fB-o\fP \fIoutfile\fP
-Output in file \fIoutfile\fP. Default is standard output.
-.TP
-.B
-\fB-a\fP \fIauthor\fP
-Set the \fIauthor\fP, on the cover page.
-.TP
-.B
-\fB-d\fP \fIdate\fP
-Set the \fIdate\fP on the cover page.
-.TP
-.B
-\fB-r\fP \fIrelease\fP
-Set the book name and \fIrelease\fP on the cover page.
-.TP
-.B
-\fB-t\fP \fItitle\fP
-Set the \fItitle\fP on the cover page.
-.TP
-.B
-\fB-v\fP \fIvolume\fP
-Specify the name of the \fIvolume\fP.
-.TP
-.B
-\fB-c\fP \fIcoverfile\fP
-Uses the file \fIcoverfile\fP to generate the cover page,
-i.e. all pages preceding the table of content. \fIcoverfile\fP
-must be in \fBgroff_ms\fP(7) format.
-.SH EXAMPLE
-To build a reference manual from section 2 man, do:
-.PP
-.nf
-.fam C
-    $ cd /usr/man/man2
-    $ bookman -p -t 'Unix Reference Manual' * >book.pdf
-
-.fam T
-.fi
-.SH SEE ALSO
-\fBman\fP(1), \fBmandoc\fP(7), \fBgroff_ms\fP(7), \fBgroff\fP(1), \fBtroff\fP(1), \fBgrops\fP(1),
-\fBgxditview\fP(1), \fBps2pdf\fP(1).
-.SH AUTHOR
-Marc Vertes <mvertes at free.fr>
diff --git a/src2man.1 b/src2man.1
deleted file mode 100644
index 4d3a94e..0000000
--- a/src2man.1
+++ /dev/null
@@ -1,85 +0,0 @@
-." Text automatically generated by txt2man
-.TH src2man 1 "21 March 2007" "txt2man-1.5.5" ""
-.SH NAME
-\fBsrc2man \fP- extract man pages from source files.
-.SH SYNOPSIS
-.nf
-.fam C
-\fBsrc2man\fP [\fB-n\fP][\fB-d\fP date][\fB-v\fP volume][\fB-r\fP \fIrelease\fP] [\fIsrcfile\fP \.\.\.]
-.fam T
-.fi
-.fam T
-.fi
-.SH DESCRIPTION
-\fBsrc2man\fP scans source file \fIsrcfile\fP. Only C source files are supported
-for now. Comments blocks starting by "/** num", where num is a section
-number, are converted into a man file, using \fBtxt2man\fP(1).
-.PP
-The first line of the comment block must contain the name of the
-manpage, usually the function name, followed by a "-" and a short
-.TP
-.B
-description.
-The following lines are the "DESCRIPTION" section
-content, except if they are in upper case, in which case they define
-a new section.
-.PP
-If the next line after a comment block is empty, Then no "SYNOPSIS"
-section will be generated. Otherwise, \fBsrc2man\fP will look in the following
-source lines for a function prototype or a type definion (struct,
-union, typedef, \.\.\.) matching the manpage name, and include it in a
-.TP
-.B
-"SYNOPSIS" section.
-This avoids to duplicate the type or function
-prototype in the comment block.
-.PP
-The best place for code documentation is in the source file, where
-the body is implemented, not the header file which only contains
-the prototype. \fBsrc2man\fP automatically searches for the presence of a
-prototype in the corresponding header file, and if found, will print a
-"#include" statement in the synopsis.
-.SH OPTIONS
-.TP
-.B
-\fB-d\fP date
-Set the date of the man pages. Defaults to current date.
-.TP
-.B
-\fB-n\fP
-No man page is created. The name of the manpages that would
-be created are printed.
-.TP
-.B
-\fB-v\fP volume
-Specify the name of the volume to be printed in center header
-of generated manpages.
-.TP
-.B
-\fB-r\fP \fIrelease\fP
-Specify the project name and \fIrelease\fP number for the generated
-manpage.
-.SH EXAMPLE
-The following example displays C code and comments to generate a manpage
-foobar.3:
-.PP
-.nf
-.fam C
-     /** 3
-      * foobar - a sample dummy function
-      * This line is now the first of the description section.
-      * Note that function parameters parm1 and parm2 are highlighted
-      * in the generated man page.
-      */
-     int foobar(char *parm1, int parm2)
-     {
-        \.\.\.
-        return 0;
-     }
-
-.fam T
-.fi
-.SH SEE ALSO
-\fBtxt2man\fP(1), \fBbookman\fP(1).
-.SH AUTHOR
-Marc Vertes <mvertes at free.fr>
diff --git a/txt2man.1 b/txt2man.1
deleted file mode 100644
index ac4b96d..0000000
--- a/txt2man.1
+++ /dev/null
@@ -1,168 +0,0 @@
-." Text automatically generated by txt2man
-.TH txt2man 1 "21 March 2007" "txt2man-1.5.5" ""
-.SH NAME
-\fBtxt2man \fP- convert flat ASCII text to man page format
-.SH SYNOPSIS
-.nf
-.fam C
-\fBtxt2man\fP [\fB-hpTX\fP] [\fB-t\fP \fImytitle\fP] [\fB-P\fP \fIpname\fP] [\fB-r\fP \fIrel\fP] [\fB-s\fP \fIsect\fP]
-        [\fB-v\fP \fIvol\fP] [\fB-I\fP \fItxt\fP] [\fB-B\fP \fItxt\fP] [\fB-d\fP \fIdate\fP] [\fIifile\fP]
-.fam T
-.fi
-.fam T
-.fi
-.SH DESCRIPTION
-\fBtxt2man\fP converts the input text into nroff/troff standard \fBman\fP(7)
-macros used to format Unix manual pages. Nice pages can be generated
-specially for commands (section 1 or 8) or for C functions reference
-(sections 2, 3), with the ability to recognize and format command and
-function names, flags, types and arguments.
-.PP
-\fBtxt2man\fP is also able to recognize and format sections, paragraphs,
-lists (standard, numbered, description, nested), cross references and
-literal display blocks.
-.PP
-If input file \fIifile\fP is omitted, standard input is used. Result is
-displayed on standard output.
-.PP
-Here is how text patterns are recognized and processed:
-.TP
-.B
-Sections
-These headers are defined by a line in upper case, starting
-column 1. If there is one or more leading spaces, a
-sub-section will be generated instead.
-.TP
-.B
-Paragraphs
-They must be separated by a blank line, and left aligned.
-.TP
-.B
-Tag list
-The item definition is separated from the item description
-by at least 2 blank spaces, even before a new line, if
-definition is too long. Definition will be emphasized
-by default.
-.TP
-.B
-Bullet list
-Bullet list items are defined by the first word being "-"
-or "*" or "o".
-.TP
-.B
-Enumerated list
-The first word must be a number followed by a dot.
-.TP
-.B
-Literal display blocks
-This paragraph type is used to display unmodified text,
-for example source code. It must be separated by a blank
-line, and be indented. It is primarily used to format
-unmodified source code. It will be printed using fixed font
-whenever possible (troff).
-.TP
-.B
-Cross references
-A cross reference (another man page) is defined by a word
-followed by a number in parenthesis.
-.PP
-Special sections:
-.TP
-.B
-NAME
-The function or command name and short description are set in
-this section.
-.TP
-.B
-SYNOPSIS
-This section receives a special treatment to identify command
-name, flags and arguments, and propagate corresponding
-attributes later in the text. If a C like function is recognized
-(word immediately followed by an open parenthesis), \fBtxt2man\fP will
-print function name in bold font, types in normal font, and
-variables in italic font. The whole section will be printed using
-a fixed font family (courier) whenever possible (troff).
-.PP
-It is a good practice to embed documentation into source code, by using
-comments or constant text variables. \fBtxt2man\fP allows to do that, keeping
-the document source readable, usable even without further formatting
-(i.e. for online help) and easy to write. The result is high quality
-and standard complying document.
-.SH OPTIONS
-.TP
-.B
-\fB-h\fP
-The option \fB-h\fP displays help.
-.TP
-.B
-\fB-d\fP \fIdate\fP
-Set \fIdate\fP in header. Defaults to current \fIdate\fP.
-.TP
-.B
-\fB-P\fP \fIpname\fP
-Set \fIpname\fP as project name in header. Default to uname \fB-s\fP.
-.TP
-.B
-\fB-p\fP
-Probe title, section name and volume.
-.TP
-.B
-\fB-t\fP \fImytitle\fP
-Set \fImytitle\fP as title of generated man page.
-.TP
-.B
-\fB-r\fP \fIrel\fP
-Set \fIrel\fP as project name and release.
-.TP
-.B
-\fB-s\fP \fIsect\fP
-Set \fIsect\fP as section in heading, ususally a value from 1 to 8.
-.TP
-.B
-\fB-v\fP \fIvol\fP
-Set \fIvol\fP as volume name, i.e. "Unix user 's manual".
-.TP
-.B
-\fB-I\fP \fItxt\fP
-Italicize \fItxt\fP in output. Can be specified more than once.
-.TP
-.B
-\fB-B\fP \fItxt\fP
-Emphasize (bold) \fItxt\fP in output. Can be specified more than once.
-.TP
-.B
-\fB-T\fP
-Text result previewing using PAGER, usually \fBmore\fP(1).
-.TP
-.B
-\fB-X\fP
-X11 result previewing using \fBgxditview\fP(1).
-.SH ENVIRONMENT
-.TP
-.B
-PAGER
-name of paging command, usually \fBmore\fP(1), or \fBless\fP(1). If not set
-falls back to \fBmore\fP(1).
-.SH EXAMPLE
-Try this command to format this text itself:
-.PP
-.nf
-.fam C
-      $ txt2man -h 2>&1 | txt2man -T
-.fam T
-.fi
-.SH HINTS
-To obtain an overall good formating of output document, keep paragraphs
-indented correctly. If you have unwanted bold sections, search for
-multiple spaces between words, which are used to identify a tag list
-(term followed by a description). Choose also carefully the name of
-command line or function parameters, as they will be emphasized each
-time they are encountered in the document.
-.SH SEE ALSO
-\fBman\fP(1), \fBmandoc\fP(7), \fBrman\fP(1), \fBgroff\fP(1), \fBmore\fP(1), \fBgxditview\fP(1), \fBtroff\fP(1).
-.SH BUGS
-.IP \(bu 3
-Automatic probe (\fB-p\fP option) works only if input is a regular file (i.e.
-not stdin).
-.SH AUTHOR
-Marc Vertes <mvertes at free.fr>

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/reproducible/txt2man.git



More information about the Reproducible-commits mailing list