40 lines
1.1 KiB
Groff
40 lines
1.1 KiB
Groff
.Dd April 14, 2022
|
|
.Dt SCMFMT 1
|
|
.Os
|
|
.Sh NAME
|
|
.Nm scmfmt
|
|
.Nd Format a commit message
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Sh DESCRIPTION
|
|
Format stdin to use as a commit message.
|
|
.Pp
|
|
.Nm
|
|
will apply the following formatting rules to the input text:
|
|
.Bl -bullet
|
|
.It
|
|
All leading blank lines will be removed.
|
|
Afterwards, any sequence of blanklines will be reduced to a single blank line.
|
|
.It
|
|
The first non blank line will be interpreted as the title.
|
|
This line will be taken as is; no wrapping nor filling will be done.
|
|
A blank line will be inserted after the title if one doesn't exist.
|
|
.It
|
|
If a line is prefixed with tabs or spaces
|
|
it will be treated as literal code
|
|
These lines will not be filled; instead, a soft wrap will be
|
|
simulated, terminating the line with a backslash and
|
|
right justifying the rest.
|
|
.It
|
|
Lines not starting with tabs or spaces will be treated as regular text.
|
|
A sequence of these lines will be filled as a single paragraph.
|
|
Breaks will only occur at blanks.
|
|
.El
|
|
.Sh EXIT STATUS
|
|
.Ex -std
|
|
.Sh SEE ALSO
|
|
.Xr fmt 1 ,
|
|
.Xr par 1
|
|
.Sh AUTHORS
|
|
.An Adolfo Perez Alvarez Aq Mt adolfopa@sdf.org
|