Jak wyświetlić bezpośrednio stronę podręcznika?

16

Piszę stronę podręcznika dla programu, który pakuję. Jak mogę wyświetlić plik strony, który utworzyłem, aby sprawdzić, czy wszystko jest w porządku? Czy istnieje sposób przekazania mojego pliku bezpośrednio do manpolecenia zamiast przeszukiwania zainstalowanych stron podręcznika według nazwy?

Próbowałem robić rzeczy, jak man myprog.1i man < myprog.1, ale w obu przypadkach Mam błąd mówiąc, że strona człowiek nie może zostać odnaleziona.

hugomg
źródło

Odpowiedzi:

24

man ma opcję odczytu pliku lokalnego: -l

-l, --local-file

Aktywuj tryb „lokalny”. Formatuj i wyświetlaj lokalne pliki instrukcji zamiast przeszukiwać kolekcję instrukcji systemowych. Każdy argument strony podręcznika będzie interpretowany jako plik źródłowy nroff we właściwym formacie. Plik cat nie jest generowany.

Jeśli „-” jest wymienione jako jeden z argumentów, dane wejściowe zostaną pobrane ze standardowego wejścia. Kiedy ta opcja nie jest używana, a man nie znajduje wymaganej strony, przed wyświetleniem komunikatu o błędzie, próbuje działać tak, jakby ta opcja została podana, używając nazwy jako nazwy pliku i szukając dokładnego dopasowania.

Możesz więc wyświetlić podgląd swojej pracy za pomocą:

man -l /path/to/manfile.1

jasonwryan
źródło
2
Zasadniczo dotyczy to Linuksa. Możesz odpowiednio ograniczyć swoją odpowiedź.
Thomas Dickey,
5
@ThomasDickey Używam tylko Linuksa; możesz edytować lub dodać odpowiedź ...
jasonwryan
15

„Stara szkoła” w przypadku systemów sprzed tej -lopcji jest

nroff -man filename | more -s
Flup
źródło
10

Użyłem po prostu

man ./path/to/man.1

Musisz dołączyć ukośnik do ścieżki, w przeciwnym razie przeszukuje katalogi systemowe. Działa na systemach Linux i OS X, które mam (ten drugi nie ma -l).

$ cd /tmp
$ cp /usr/share/man/man1/ls.1 .
$ man ls.1
No manual entry for ls.1
$ man ./ls.1     # works
ilkkachu
źródło
1

W systemie Solaris -Mprzełącznik na manzastąpi ścieżkę wyszukiwania dla stron podręcznika: -

man -M path/to/man myprog

Plik strony man musi znajdować się w odpowiednim podkatalogu odpowiadającym sekcji i języku znaczników, np .: path/to/man/man1/myprog.1dla strony nroff w sekcji 1.

crw
źródło