Hello community,
here is the log from the commit of package txt2man for openSUSE:Factory checked
in at 2020-11-24 22:14:09
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Comparing /work/SRC/openSUSE:Factory/txt2man (Old)
and /work/SRC/openSUSE:Factory/.txt2man.new.5913 (New)
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Package is "txt2man"
Tue Nov 24 22:14:09 2020 rev:4 rq:850392 version:1.7.1
Changes:
--------
--- /work/SRC/openSUSE:Factory/txt2man/txt2man.changes 2018-03-13
10:24:11.473442191 +0100
+++ /work/SRC/openSUSE:Factory/.txt2man.new.5913/txt2man.changes
2020-11-24 22:14:26.875604998 +0100
@@ -1,0 +2,17 @@
+Tue Nov 24 09:39:42 UTC 2020 - Martin Pluskal <[email protected]>
+
+- Update to version 1.7.1:
+ * txt2man: remove ksh check (@eribertomota)
+ * src2man: make it compliant with gawk >= 5.0.1 (@eribertomota)
+ * txt2man: allow punctuation characters in section names
+ * txt2man: allow display blocks starting with a number
+ * *man: check for dependencies (@eribertomota)
+ * build: make build reproducible
+- Changes for version 1.7.0:
+ * bookman: added missing space (@marxst)
+ * txt2man: remove redundant escapes causing gawk warnings (@jolmg)
+ * *man: Fix usage of the date command on BSD systems (@ismaell)
+ * txt2man: fix -B option (@bgstack15)
+ * src2man: Print names of manuals to stdout (@ldorau)
+
+-------------------------------------------------------------------
Old:
----
txt2man-1.6.0.tar.gz
New:
----
txt2man-1.7.1.tar.gz
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Other differences:
------------------
++++++ txt2man.spec ++++++
--- /var/tmp/diff_new_pack.0gdmU7/_old 2020-11-24 22:14:27.843605895 +0100
+++ /var/tmp/diff_new_pack.0gdmU7/_new 2020-11-24 22:14:27.847605899 +0100
@@ -1,7 +1,7 @@
#
# spec file for package txt2man
#
-# Copyright (c) 2018 SUSE LINUX GmbH, Nuernberg, Germany.
+# Copyright (c) 2020 SUSE LLC
#
# All modifications and additions to the file contributed by third parties
# remain the property of their copyright owners, unless otherwise agreed
@@ -12,12 +12,12 @@
# license that conforms to the Open Source Definition (Version 1.9)
# published by the Open Source Initiative.
-# Please submit bugfixes or comments via http://bugs.opensuse.org/
+# Please submit bugfixes or comments via https://bugs.opensuse.org/
#
Name: txt2man
-Version: 1.6.0
+Version: 1.7.1
Release: 0
Summary: Convert Flat ASCII Text to man Page Format
License: GPL-2.0-or-later
@@ -32,9 +32,10 @@
script using gnu awk, that should run on any Unix like system.
%prep
-%setup -q -n txt2man-txt2man-1.6.0
+%autosetup -n %{name}-%{name}-%{version}
%build
+%make_build
%install
install -Dpm 0755 bookman %{buildroot}%{_bindir}/bookman
++++++ txt2man-1.6.0.tar.gz -> txt2man-1.7.1.tar.gz ++++++
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/txt2man-txt2man-1.6.0/Changelog
new/txt2man-txt2man-1.7.1/Changelog
--- old/txt2man-txt2man-1.6.0/Changelog 2016-08-15 15:46:03.000000000 +0200
+++ new/txt2man-txt2man-1.7.1/Changelog 2020-06-28 23:29:16.000000000 +0200
@@ -1,3 +1,20 @@
+txt2man-1.7.1 28-jun-2020
+
+* txt2man: remove ksh check (@eribertomota)
+* src2man: make it compliant with gawk >= 5.0.1 (@eribertomota)
+* txt2man: allow punctuation characters in section names
+* txt2man: allow display blocks starting with a number
+* *man: check for dependencies (@eribertomota)
+* build: make build reproducible
+
+txt2man-1.7.0 03-jun-2020
+
+* bookman: added missing space (@marxst)
+* txt2man: remove redundant escapes causing gawk warnings (@jolmg)
+* *man: Fix usage of the date command on BSD systems (@ismaell)
+* txt2man: fix -B option (@bgstack15)
+* src2man: Print names of manuals to stdout (@ldorau)
+
txt2man-1.6.0 15-aug-2016
* txt2man: Format date with C locale (by @Vogtinator)
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/txt2man-txt2man-1.6.0/Makefile
new/txt2man-txt2man-1.7.1/Makefile
--- old/txt2man-txt2man-1.6.0/Makefile 2016-08-15 15:46:03.000000000 +0200
+++ new/txt2man-txt2man-1.7.1/Makefile 2020-06-28 23:29:16.000000000 +0200
@@ -1,6 +1,7 @@
# Makefile
prefix ?= /usr/local
-version = txt2man-1.6.0
+version = txt2man-1.7.1
+date = 2020-06-28
BIN = src2man bookman txt2man
MAN1 = src2man.1 txt2man.1 bookman.1
@@ -14,7 +15,7 @@
clean:
rm -f *.1 *.txt *.ps *.pdf *.html
-%.1:%.txt; ./txt2man -s 1 -t $* -r $(version) $< > $@
+%.1:%.txt; ./txt2man -s 1 -t $* -r $(version) -d $(date) $< > $@
%.txt:%; ./$< -h 2>&1 > $@
%.html:%.1; rman -f HTML $< > $@
%.ps:%.1; groff -man $< > $@
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/txt2man-txt2man-1.6.0/README
new/txt2man-txt2man-1.7.1/README
--- old/txt2man-txt2man-1.6.0/README 2016-08-15 15:46:03.000000000 +0200
+++ new/txt2man-txt2man-1.7.1/README 2020-06-28 23:29:16.000000000 +0200
@@ -12,6 +12,6 @@
or
make install prefix=path
-Send comments, suggestions and bug reports to [email protected]
+Issues and pull requests should be opened at
https://github.com/mvertes/txt2man.
-- Marc Vertes
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/txt2man-txt2man-1.6.0/bookman
new/txt2man-txt2man-1.7.1/bookman
--- old/txt2man-txt2man-1.6.0/bookman 2016-08-15 15:46:03.000000000 +0200
+++ new/txt2man-txt2man-1.7.1/bookman 2020-06-28 23:29:16.000000000 +0200
@@ -18,7 +18,7 @@
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
# 02111-1307, USA.
-# release 1.5.6
+# release 1.7.1
man() {
cat << \EOT
@@ -84,10 +84,29 @@
esac
done
shift $(($OPTIND - 1))
+
+# Check for dependencies
+ groff -ms /dev/null || {
+ printf "ERROR: You need install groff.\n" >&2
+ exit 1
+ }
+
+ps2pdf 2>&1 | grep -q Usage || {
+ printf "ERROR: You need install ghostscript.\n" >&2
+ exit 1
+ }
+
+# Compatibility wrapper for BSD/GNU date, for parsing dates
+if date -j >/dev/null 2>&1; then
+ pdate() { date -u -j -f '@%s' "$@"; }
+else
+ pdate() { date -u -d "$@"; }
+fi
+
if [ -n "$SOURCE_DATE_EPOCH" ]; then
- date=$(LC_ALL=C date -u -d "@$SOURCE_DATE_EPOCH" +'%d %B %Y')
+ date=$(LC_ALL=C pdate "@$SOURCE_DATE_EPOCH" +'%d %B %Y')
fi
-date=${date:-$(date +'%d %B %Y')}
+date=${date:-$(LC_ALL=C date -u +'%d %B %Y')}
[ $1 ] || set -- $(while read REPLY; do echo "$REPLY"; done)
@@ -110,7 +129,7 @@
for f
do
case $f in
- (*.Z|*.gz) zcat$f;;
+ (*.Z|*.gz) zcat $f;;
(*.bz2) bzcat $f;;
(*) cat $f;;
esac
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/txt2man-txt2man-1.6.0/bookman.1
new/txt2man-txt2man-1.7.1/bookman.1
--- old/txt2man-txt2man-1.6.0/bookman.1 2016-08-15 15:46:03.000000000 +0200
+++ new/txt2man-txt2man-1.7.1/bookman.1 1970-01-01 01:00:00.000000000 +0100
@@ -1,85 +0,0 @@
-.\" Text automatically generated by txt2man
-.TH bookman 1 "15 August 2016" "txt2man-1.6.0" ""
-.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 ENVIRONMENT
-.TP
-.B
-SOURCE_DATE_EPOCH
-Unix timestamp that is used for \fIdate\fP in header instead
-of current \fIdate\fP.
-.SH EXAMPLE
-To build a reference manual from section 2 man, do:
-.PP
-.nf
-.fam C
- $ cd /usr/share/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 <[email protected]>
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/txt2man-txt2man-1.6.0/src2man
new/txt2man-txt2man-1.7.1/src2man
--- old/txt2man-txt2man-1.6.0/src2man 2016-08-15 15:46:03.000000000 +0200
+++ new/txt2man-txt2man-1.7.1/src2man 2020-06-28 23:29:16.000000000 +0200
@@ -18,7 +18,7 @@
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
# 02111-1307, USA.
-# release 1.5.6
+# release 1.7.1
man() {
cat << \EOT
@@ -97,10 +97,18 @@
esac
done
shift $(($OPTIND - 1))
+
+# Compatibility wrapper for BSD/GNU date, for parsing dates
+if date -j >/dev/null 2>&1; then
+ pdate() { date -u -j -f '@%s' "$@"; }
+else
+ pdate() { date -u -d "$@"; }
+fi
+
if [ -n "$SOURCE_DATE_EPOCH" ]; then
- date=$(LC_ALL=C date -u -d "@$SOURCE_DATE_EPOCH" +'%d %B %Y')
+ date=$(LC_ALL=C pdate "@$SOURCE_DATE_EPOCH" +'%d %B %Y')
fi
-date=${date:-$(date +'%d %B %Y')}
+date=${date:-$(LC_ALL=C date -u +'%d %B %Y')}
#
# Extract manpages from source files. Man page content is enclosed in
@@ -169,18 +177,18 @@
getline
synop = synop " " $0
}
- if ($0 ~/\)[ \t{}\;]*$/) {
+ if ($0 ~/\)[ \t{};]*$/) {
sub(/{[^}]}/, "", synop)
sub(/[ \t]*$/, "", synop)
if (found == "ok")
synop = "#include \"" inc "\"\n" synop
- if (synop !~ /\;$/)
+ if (synop !~ /;$/)
synop = synop ";"
break
}
}
}
- print title "." sect > "/dev/stderr"
+ print title "." sect > "/dev/stdout"
if (nogen) {
name = synop = desc = sect = ""
next
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/txt2man-txt2man-1.6.0/src2man.1
new/txt2man-txt2man-1.7.1/src2man.1
--- old/txt2man-txt2man-1.6.0/src2man.1 2016-08-15 15:46:03.000000000 +0200
+++ new/txt2man-txt2man-1.7.1/src2man.1 1970-01-01 01:00:00.000000000 +0100
@@ -1,85 +0,0 @@
-.\" Text automatically generated by txt2man
-.TH src2man 1 "15 August 2016" "txt2man-1.6.0" ""
-.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
-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
-"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 ENVIRONMENT
-.TP
-.B
-SOURCE_DATE_EPOCH
-Unix timestamp that is used for date in header instead
-of current date.
-.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 <[email protected]>
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/txt2man-txt2man-1.6.0/txt2man
new/txt2man-txt2man-1.7.1/txt2man
--- old/txt2man-txt2man-1.6.0/txt2man 2016-08-15 15:46:03.000000000 +0200
+++ new/txt2man-txt2man-1.7.1/txt2man 2020-06-28 23:29:16.000000000 +0200
@@ -1,5 +1,4 @@
#!/bin/sh
-test "$HOME" = ~ || exec ksh $0 "$@" # try ksh if sh too old (not yet POSIX)
# Copyright (C) 2001, 2002, 2003 Marc Vertes
@@ -18,7 +17,7 @@
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
# 02111-1307, USA.
-# release 1.5.6
+# release 1.7.1
usage()
{
@@ -151,18 +150,26 @@
(v) volume=$OPTARG;;
(P) sys=$OPTARG;;
(p) doprobe=1;;
- (I) itxt="$OPTARG�$itxt";;
- (B) btxt=$OPTARG;;
+ (I) itxt="$OPTARG§$itxt";;
+ (B) btxt="$OPTARG§$btxt";;
(T) post="groff -mandoc -Tlatin1 | ${PAGER:-more}";;
- (X) post="groff -mandoc -X";;
+ (X) post="groff -mandoc -X -P-resolution -P100";;
(*) usage; exit;;
esac
done
shift $(($OPTIND - 1))
+
+# Compatibility wrapper for BSD/GNU date, for parsing dates
+if date -j >/dev/null 2>&1; then
+ pdate() { date -u -j -f '@%s' "$@"; }
+else
+ pdate() { date -u -d "$@"; }
+fi
+
if [ -n "$SOURCE_DATE_EPOCH" ]; then
- date=$(LC_ALL=C date -u -d "@$SOURCE_DATE_EPOCH" +'%d %B %Y')
+ date=$(LC_ALL=C pdate "@$SOURCE_DATE_EPOCH" +'%d %B %Y')
fi
-date=${date:-$(LC_ALL=C date +'%d %B %Y')}
+date=${date:-$(LC_ALL=C date -u +'%d %B %Y')}
if test "$doprobe"
then
@@ -191,7 +198,7 @@
avar[1] = btxt; avar[2] = itxt
for (k in avar) {
mark = (k == 1) ? "\\fB" : "\\fI"
- split(avar[k], tt, "�")
+ split(avar[k], tt, "§")
for (i in tt)
if (tt[i] != "")
subwords["\\<" tt[i] "\\>"] = mark tt[i] "\\fP"
@@ -207,7 +214,7 @@
# remove spaces in empty lines
sub(/^ +$/,"")
}
-/^[[:upper:][:space:]]+$/ {
+/^[[:upper:][:space:][:digit:][:punct:]]+$/ {
# Section header
if ((in_bd + 0) == 1) {
in_bd = 0
@@ -242,7 +249,7 @@
pnzls = ls
match($0, /[^ ]/)
ls = RSTART
- if (pls == 0 && pnzls > 0 && ls > pnzls && $1 !~ /^[0-9\-\*\o]\.*$/) {
+ if (in_bd == 0 && pls == 0 && pnzls > 0 && ls > pnzls && $1 !~
/^[\-\*o]$|^[0-9]+\.$/) {
# example display block
if (prevblankline == 1) {
print ".PP"
@@ -300,7 +307,7 @@
} else if ($1 == "#define")
subwords["\\<" $2 "\\>"] = "\\fI" $2 "\\fP"
for (i = 1; i <= NF; i++) {
- if ($i ~ /[\,\)]\;*$/) {
+ if ($i ~ /[,\)];*$/) {
a = $i
sub(/.*\(/, "", a)
gsub(/\W/, "", a)
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/txt2man-txt2man-1.6.0/txt2man.1
new/txt2man-txt2man-1.7.1/txt2man.1
--- old/txt2man-txt2man-1.6.0/txt2man.1 2016-08-15 15:46:03.000000000 +0200
+++ new/txt2man-txt2man-1.7.1/txt2man.1 1970-01-01 01:00:00.000000000 +0100
@@ -1,188 +0,0 @@
-.\" Text automatically generated by txt2man
-.TH txt2man 1 "15 August 2016" "txt2man-1.6.0" ""
-.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. Optionally, the
-Section name can be preceded by a blank line. This is useful
-for a better visualization of the source text to be used to
-generate the manpage.
-.TP
-.B
-Paragraphs
-They must be separated by a blank line, and left aligned.
-Alternatively two blank spaces can be used to produce the
-same result. This option will provide a better visualization
-of the source text to be used to generate the manpage.
-.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 by a TAB. 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 one 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, usually 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).
-.TP
-.B
-SOURCE_DATE_EPOCH
-Unix timestamp that is used for \fIdate\fP in header instead
-of current \fIdate\fP.
-.SH EXAMPLES
-Try this command to format this text itself:
-.PP
-.nf
-.fam C
- $ txt2man -h 2>&1 | txt2man -T
-
-.fam T
-.fi
-The following command will generate a manpage level 1 to foo-1.1.0 program,
-from foo.txt file, used as source code to previously mentioned manpage:
-.PP
-.nf
-.fam C
- $ txt2man -d "15 May 2016" -t foo -r foo-1.1.0 -s 1 -v "show stars on
screen" foo.txt > foo.1
-.fam T
-.fi
-.SH HINTS
-To obtain an overall good formatting 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 <[email protected]>_______________________________________________
openSUSE Commits mailing list -- [email protected]
To unsubscribe, email [email protected]
List Netiquette: https://en.opensuse.org/openSUSE:Mailing_list_netiquette
List Archives:
https://lists.opensuse.org/archives/list/[email protected]
