Conventional formatting and some fixes for man page #21

Merged

Mudskipper875 merged 3 commits from manpage into next

2022-04-19 19:34:13 +00:00

Mudskipper875 commented

2021-10-14 19:59:54 +00:00

(Migrated from github.com)

Changes

Use .OP macro in the SYNOPSIS section which will handle the font as
well as the page width.
Use macros like .B, .I and .BR instead of inline escapes.
Use .TP instead of .PP in the OPTIONS section, which will handle the
indentation and the first line-break.
Change orientation of the table to maintain page width.
Added missing newline in the table formatting for the "excercises" mode.
Add COPYRIGHT section with licesne.

## Changes - Use `.OP` macro in the SYNOPSIS section which will handle the font as well as the page width. - Use macros like `.B`, `.I` and `.BR` instead of inline escapes. - Use `.TP` instead of `.PP` in the OPTIONS section, which will handle the indentation and the first line-break. - Change orientation of the table to maintain page width. - Added missing newline in the table formatting for the "excercises" mode. - Add COPYRIGHT section with licesne.

budRich commented

2022-04-19 19:34:06 +00:00

(Migrated from github.com)

Hello @Mudskipper875 Thanks for the PR!
I think your version of the manpage is much better than the autogenerated ones.

however, the manpages for all my projects are autogenerated from markdown documents by go-md2man or lowdown. And the content of the manpages are shared with other parts of the project (README.md, output of --help, wiki).

I am actually currently in the process of updating my homebrewed buildystem (budlabs/bashbud) and all my projects that uses it. And since the manpage is autogenerated, they will no longer be included in the repositories (instead generated with other documents via make).

So, I will merge this, but. I will also soon update this repo, where no manpage is included, and sadly, the generated one will be as bad as the one you have fixed.

Hello @Mudskipper875 Thanks for the PR! I think your version of the manpage is much better than the autogenerated ones. however, the manpages for all my projects are autogenerated from markdown documents by `go-md2man` or `lowdown`. And the content of the manpages are shared with other parts of the project (README.md, output of `--help`, wiki). I am actually currently in the process of updating my homebrewed buildystem (budlabs/bashbud) and all my projects that uses it. And since the manpage is autogenerated, they will no longer be included in the repositories (instead generated with other documents via `make`). So, I will merge this, but. I will also soon update this repo, where no manpage is included, and sadly, the generated one will be as bad as the one you have fixed.

Mudskipper875 commented

2022-05-14 04:10:38 +00:00

(Migrated from github.com)

Oh I see. Thanks anyway!