search

teuben / nemo

a Stellar Dynamics Toolbox (Not Everybody Must Observe)
https://astronemo.readthedocs.io
GNU General Public License v2.0
58 stars 43 forks source link

badly formatted man pages #126

Open teuben opened 10 months ago

teuben commented 10 months ago

This is a very old issue. With the "manpdf" script a man page can be turned into a pretty pdf file, but tab alignments (e.g. in the HISTORY section) is different from the terminal version. Generally we use ".ta +1.5i +5.5i"

Secondly, to gives examples of code, we should not use the ".nf .fi" section, but use ".EX .EE". Example of this fix is in mkplummer and hackdens.

There probably are more issues. man pages are probably considered legacy, but darn useful in a terminal.

teuben commented 3 months ago

It seems ".ta +1.25i +4.5i" is a better default for the output PDF, but tight for terminals.

teuben commented 2 months ago

Another new formatting idea is to put ".br" before the default. But now we have several ways how to write the default:

[Default: 1.0]
[1.0]
Default: 1.0
default: 1.0