Automatyzacja pisania własnych `manpage`

W ramach pracy zawodowej zdarza mi się pisać artykuły. Poniżej link do mojego tekstu traktującego o pisaniu własnych manpages. W ten sposób można też bardzo łatwo tworzyć notatki na własne potrzeby lub w celach pisania dokumentacji projektu przewidzianego do pracy w systemach uniksopodobnych.

• Własna dokumentacja z wykorzystaniem polecenia man

Ponieważ jest kilka rzeczy, które nie zmieściły się w tamtym artykule umieszam je tutaj na zachętę oraz jako uzupełnienie :)

Wypisanie wyszystkich stron manuala z danej sekcji

SEKCJA='1p'
$ man -S $SEKCJA -k --regex '.*'

Krótki opis opcji:

• -S (lub -s) pozwala na wybranie sekcji, które będą przeszukiwane
• -k powoduje, że wyjście będzie jak z komendy apropos(1)
• --regex będzie dopasowywać linie wyjścia z podanym wzorcem. Tutaj korzystamy z .* co można traktować jako dowolny ciąg znaków.

Po stworzeniu własnej sekcji w ten sposób można łatwo odnaleźć wszystkie strony, które do niej należą.

Otwarcie strony podręcznika w przeglądarce

Korzystając ze środowiska na maszynie roboczej, raczej niż na serwerze można przeczytać strony podręcznika w formacie HTML w ulubionej przeglądarce.

$ man -Hfirefox 1p who

Opcja -H z nazwą programu, w którym chcemy otworzyć daną stronę pozwala na wykorzystanie formatu HTML. Ciekawostka, kod źródłowy wygenerowany przez troff można sobie otworzyć w terminalu np przez podanie jakiegoś programu-pagera.

$ man -H$PAGER 1p who