Skip to content

Commit

Permalink
Add manpage
Browse files Browse the repository at this point in the history
It was written for the Debian GNU/Linux system but may be used by others.
  • Loading branch information
Sergio de Almeida Cipriano Junior committed Mar 9, 2021
1 parent 4eb4b24 commit 16d1263
Showing 1 changed file with 163 additions and 0 deletions.
163 changes: 163 additions & 0 deletions towncrier.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
.ds command towncrier
.ds COMMAND TOWNCRIER

.TH "\*[COMMAND]" 1 "2020-03-08" "Debian"

.SH NAME
.B \*[command]
\- Compiler for project news file

.SH SYNOPSIS

.SY \*[command]
.OP build
.OP check
.OP create FRAGMENTFILE
.YS

.SY \*[command]
.OP \-\-config
.YS

.SY \*[command]
.OP \-\-date=<YYYY-MM-DD>
.YS

.SY \*[command]
.OP \-\-dir
.YS

.SY \*[command]
.OP -h
.YS

.SY \*[command]
.OP \-\-name
.YS

.SY \*[command]
.OP \-\-version=<yourprojectversion>
.YS

.SY \*[command]
.OP -v
.YS

.SH DESCRIPTION

.P
Towncrier is a utility to produce useful, summarised news files for your project.
Rather than reading the Git history as some newer tools to produce it, or having
one single file which developers all write to, towncrier reads "news fragments"
which contain information useful to end users.

.P
Towncrier delivers the news which is convenient to those that hear it, not those
that write it.

.P
That is, a “news fragment” (a small file containing just enough information to
be useful to end users) can be written that summarises what has changed from the
“developer log” (which may contain complex information about the original issue,
how it was fixed, who authored the fix, and who reviewed the fix). By compiling
a collection of these fragments, towncrier can produce a digest of the changes
which is valuable to those who may wish to use the software.

.SH COMMAND LINE OPTIONS

.TP
.B build
Build a combined news file from news fragment. With the option
.B \-\-draft,
render the news fragments, don't write to files, don't check versions.

.TP
.BI check
Check for new fragments on a branch.

.TP
.BI create " FRAGMENTFILE"
.RS
.P
Create a new news fragment called FRAGMENTFILE. Towncrier has a few standard
types of news fragments, signified by the file extension. These are:
.RS
.TP
".feature": a new feature,
.TP
".bugfix": a bug fix,
.TP
".doc": a documentation improvement,
.TP
".removal": a deprecation or removal of public API,
.TP
".misc": a ticket has been closed, but it is not of interest to users,
.RE
.RE

.TP
.BI --config " CONFIGFILE"
Configuration file name. If
.I CONFIGFILE
is not defined, towncrier will look for towncrier.toml or pyproject.toml file
(if both files exist, the first will take precedence).

.TP
.B --date=<YYYY-MM-DD>
Towncrier will include the date when generating news file, you can specify the
date if needed.

.TP
.BI --dir " DIRECTORY"
Directory the fragment should be created.

.TP
.B -h
Display usage commands (not every command line option will be printed).

.TP
.B --name
Define project name.

.TP
.B --version=<yourprojectversion>
Render the news fragments using given version.

.TP
.B -v
Display version information.

.SH REPORTING BUGS

.P
Please report any bugs using the GitHub issue tracker:
.TQ
https://github.com/twisted/towncrier/issues/new

.SH SEE ALSO

.P
For more information, you may visit the source code:
.TQ
https://github.com/twisted/towncrier/

.SH AUTHOR
\fBTowncrier\fR is copyright (c) 2015-2016, Amber Brown, meejah.

.P
This manual page was completely written by Sergio Cipriano <sergiosacj@hotmail.com.br>.
It was written for the Debian GNU/Linux system but may be used by others.

.P
This is free software: you may copy, modify, and/or distribute this work
under the terms of the GNU General Public License as published by the
Free Software Foundation; version 3 of that license or any later version.
No warranty expressed or implied.

.\" Copyright © 2021 Sérgio de Almeida Cipriano Junior <sergiosacj@hotmail.com.br>
.
.\" This is free software: you may copy, modify, and/or distribute this work
.\" under the terms of the GNU General Public License as published by the
.\" Free Software Foundation; version 3 of that license or any later version.
.\" No warranty expressed or implied.
.

0 comments on commit 16d1263

Please sign in to comment.