|
3 | 3 | .Os |
4 | 4 | .Sh NAME |
5 | 5 | .Nm bemuse |
6 | | -.Nd quickly convert a Muse document to HTML |
| 6 | +.Nd convert Muse documents to HTML |
7 | 7 | . |
8 | 8 | .Sh SYNOPSIS |
9 | 9 | .Nm |
10 | | -.Op Ar files |
11 | | -.Pp |
12 | | -.Nm |
13 | | -.Op < Ar stdin |
| 10 | +.Ar files \&\.\.\.\& |
14 | 11 | . |
15 | 12 | .Sh DESCRIPTION |
16 | 13 | .Nm |
17 | 14 | formats a list of Muse |
18 | 15 | .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 . |
28 | 24 | . |
29 | 25 | .Pp |
30 | | -If there are no files passed on the command-line, |
| 26 | +If no |
| 27 | +.Ar files |
| 28 | +are passed, |
31 | 29 | .Nm |
32 | | -reads from stdin and writes to standard output. |
| 30 | +reads from standard input and writes HTML to stdout. |
33 | 31 | . |
34 | 32 | .Sh FILES |
35 | | -.Pa TEMP_FILE_LOL\.tmp\~ |
| 33 | +.Pa TEMP_FILE_LOL\.tmp~ |
| 34 | +.Bd -ragged -offset 4n -compact |
36 | 35 | Created in the executable's directory when reading from stdin. |
| 36 | +Deleted after |
| 37 | +.Nm |
| 38 | +finishes producing output. |
| 39 | +. |
| 40 | +.Pp |
37 | 41 | A limitation of |
38 | 42 | .Xr Text::Amuse 3pm |
39 | 43 | 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 |
42 | 49 | . |
43 | 50 | .Sh EXIT STATUS |
44 | 51 | .Ex -std |
45 | 52 | . |
46 | 53 | .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 |
51 | 58 | . |
52 | 59 | .Pp |
53 | 60 | 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 |
58 | 66 | . |
59 | 67 | .Sh SEE ALSO |
| 68 | +.Xr cpan 1 , |
60 | 69 | .Xr perl 1 , |
61 | 70 | .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