Skip to content

Commit d9032e4

Browse files
committed
Fix formatting of manual-page
1 parent 1cf02a6 commit d9032e4

File tree

1 file changed

+52
-27
lines changed

1 file changed

+52
-27
lines changed

spec/tools/bemuse.1

Lines changed: 52 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,59 +3,84 @@
33
.Os
44
.Sh NAME
55
.Nm bemuse
6-
.Nd quickly convert a Muse document to HTML
6+
.Nd convert Muse documents to HTML
77
.
88
.Sh SYNOPSIS
99
.Nm
10-
.Op Ar files
11-
.Pp
12-
.Nm
13-
.Op < Ar stdin
10+
.Ar files \&\.\.\.\&
1411
.
1512
.Sh DESCRIPTION
1613
.Nm
1714
formats a list of Muse
1815
.Ar files
19-
using the
20-
.Xr Text::Amuse 3pm
21-
module from
22-
.Xr cpan 1 .
23-
Output is basic HTML with
24-
.Li .html
25-
replacing the file's
26-
.Li .muse
27-
extension.
16+
as plain HTML using
17+
.Xr Text::Amuse 3pm .
18+
Output is written to
19+
.Ar /path/to/input Ns No \.muse ,
20+
replacing
21+
.Ql \.muse
22+
with
23+
.Ql \.html .
2824
.
2925
.Pp
30-
If there are no files passed on the command-line,
26+
If no
27+
.Ar files
28+
are passed,
3129
.Nm
32-
reads from stdin and writes to standard output.
30+
reads from standard input and writes HTML to stdout.
3331
.
3432
.Sh FILES
35-
.Pa TEMP_FILE_LOL\.tmp\~
33+
.Pa TEMP_FILE_LOL\.tmp~
34+
.Bd -ragged -offset 4n -compact
3635
Created in the executable's directory when reading from stdin.
36+
Deleted after
37+
.Nm
38+
finishes producing output.
39+
.
40+
.Pp
3741
A limitation of
3842
.Xr Text::Amuse 3pm
3943
is that a filename is required to instantiate a new document.
40-
The aforementioned filename \(em unlikely to be in-use by the filesystem \(em
41-
is removed once the output has been generated.
44+
The aforementioned filename is unlikely to be used by the filesystem,
45+
in the same directory from which
46+
.Nm
47+
is running.
48+
.Ed
4249
.
4350
.Sh EXIT STATUS
4451
.Ex -std
4552
.
4653
.Sh EXAMPLES
47-
Write converted HTML to stdout:
48-
.Bd -literal
49-
.Nm < Ar input
50-
.Ed
54+
Write
55+
.Dq <strong>bold</strong>
56+
to standard output:
57+
.Dl $ Nm echo Ar \&'**bold**' No \&| Nm bemuse
5158
.
5259
.Pp
5360
Create
54-
.Ar file.html :
55-
.Bd -literal
56-
.Nm Ar file.muse
57-
.Ed
61+
.Ar A.html ,
62+
.Ar B.html ,
63+
and
64+
.Ar C.html :
65+
.Dl $ Nm Ar {A,B,C}.muse
5866
.
5967
.Sh SEE ALSO
68+
.Xr cpan 1 ,
6069
.Xr perl 1 ,
6170
.Xr Text::Amuse 3pm
71+
.
72+
.Pp
73+
The
74+
.Lk https://amusewiki.org/library/manual "AmuseWiki online documentation" .
75+
.
76+
.Sh AUTHORS
77+
.An -nosplit
78+
Smashed together in 30 minutes by
79+
.An Alhadis Aq Mt gardnerjohng\&@\&gmail.com .
80+
Admittedly, not his best work.
81+
.
82+
.Sh BUGS
83+
Despite the name,
84+
.Nm
85+
was a product of frustration and impatience.
86+
Its author used the first name which came to their head.

0 commit comments

Comments
 (0)