Nie mam pojęcia, w jaki sposób mogę udostępnić własne skrypty specjalistyczne (napisane głównie w języku Bash i Perl) za pośrednictwem man
stron.
Jaką procedurę musiałbym zastosować i czy istnieje szczególny format, w którym dokumentacja musi być napisana, aby móc to zrobić?
man
documentation
Zaid
źródło
źródło
info
jest nowyman
.Odpowiedzi:
Przekonałem się, że korzystanie z POD POD Perla jest o wiele łatwiejsze niż bezpośrednie pisanie stron podręcznika użytkownika i możesz utworzyć stronę podręcznika użytkownika z pliku POD za pomocą
pod2man
narzędzia (część podstawowego pakietu Perla). Ponieważ niektóre pliki wykonywalne są już napisane w Perlu, możesz dodać formatowanie POD bezpośrednio do swoich skryptów i można je bezpośrednio przekształcić w pliki POD. Widziałem także kilka projektów wykorzystujących format POD, mimo że ich kod jest napisany w innych językach, ze względu na prostotę POD.Aby dodać dodatkowy katalog stron podręcznika, możesz ustawić
$MANPATH
zmienną środowiskową. Prefiks$MANPATH
z,:
aby dodać go do listy już skonfigurowanych ścieżek man. Użyjmanpath
polecenia, aby zobaczyć aktualnie zdefiniowane ścieżki man.źródło
W skrócie zobacz
man groff_man
format pliku ( wersja internetowa ).Zapisz go
/usr/local/man/man1
lub/usr/share/man/man1
jeśli to nie zadziała.Zobacz stronę podręcznika użytkownika HOWTO, aby uzyskać więcej informacji.
źródło
groff_an
lubgroff_man
, ale może być konieczne zainstalowanie pakietu innego niż domyślny, aby go uzyskać.groff_an
, i dla większości ludzi tak będzie,groff_man
jeśli o to ci chodziło. :-)Spróbuj
pandoc
- używa rozszerzonej składni Markdown znanej z StackOverflow .Oto przykład strony podręcznika :
Aby przekonwertować go na uruchomienie strony man:
Wizualizowany wynik konwersji (fragment wygenerowanej strony podręcznika):
Można zainstalować Pandoc z repozytoriów w większości popularnych linuksowych dystrybucji .
Więcej linków:
źródło
Od jakiegoś czasu korzystam z tego szybkiego i łatwego samouczka do tworzenia niestandardowych stron podręcznika man .
Ogólny proces wygląda następująco:
sed
skrypt, aby sformatowaćnroff
nroff
Następnie możesz opcjonalnie (b | g) spakować go i umieścić w odpowiednim katalogu man.
źródło
Według tej strony jest to łatwe:
Następnie wklej i zmodyfikuj przykład taki jak ten. Ta strona (lub
man 7 mdoc
) wyjaśnia opcje formatowania:Następnie po prostu zgzipuj i skopiuj swoją nową stronę man do odpowiedniej sekcji man:
Ponieważ przykład jest narzędziem administracyjnym, opisano go w sekcji 8:
Lub poproś ludzi, aby przeczytali go z innej lokalizacji , np. Lokalnie:
man ./nuseradd
źródło
sudo su
Umieść w pliku o nazwie „md2man.sh” lub do wyboru, jak chcesz.
Stosowanie:
md2man.sh myManPage.md
Krótka uwaga: nie wszystkie groff,
-T
obsługa urządzeń wyjściowych utf8. Utf8 działa w groff, jednak nie jest obsługiwane przez wszystkie sterowniki. Na przykładpdf
ips
nie działają z wejściem utf8. Jeśli-Kutf8
używałeś groff weźmie wejście utf8. Inne sterowniki, takie jakhtml
i tekst wyjściowy jako uft8,-Tutf8
wykonują dane wyjściowe ze znakami utf8.źródło