Jak stworzyć stronę podręcznika dla systemu Linux

Komenda Człowiek w systemie Linux jest osadzony w pamięci mięśniowej każdego programisty i użytkownika Linuksa. Używają go dosłownie wszyscy; od amatorskich i początkujących programistów po profesjonalistów i ekspertów Linuksa.

Jest używany do czytania strony podręcznika wiersza poleceń dla polecenia Linuksa, pliku konfiguracyjnego lub dowolnej innej funkcji. Strony podręcznika są zwykle instalowane wraz z instalacją oprogramowania w systemie Linux. Dla stron podręcznika istnieje zdefiniowana składnia, która jest analizowana przez polecenie.

Stwórzmy stronę podręcznika dla następującego skryptu bash, który napisałem:

#!/bin/bash if [ "$1" == "h" ]; następnie echo "Witaj" fi if [ "$1" = "b" ]; następnie powtórz "pa" fi

Ten skrypt robi tylko dwie rzeczy: wypisuje „Hello”, jeśli jako argument podano opcję „h”, i wyświetla „Bye”, jeśli jako argument podano opcję „b”.

Stwórzmy stronę podręcznika dla tego programu. Posługiwać się krzepkość lub dowolny edytor, aby utworzyć plik tekstowy.

test vima.1

Rozszerzenie „.1” oznacza, że ​​ta strona podręcznika służy do wykonywania polecenia. Nie jest to przymus, ale raczej szeroko stosowana konwencja podczas pisania stron podręcznika. Strona podręcznika man (człowiek człowieku !) wymienia kategorie:

 1 Programy wykonywalne lub polecenia powłoki 2 Wywołania systemowe (funkcje dostarczane przez jądro) 3 Wywołania bibliotek (funkcje w bibliotekach programów) 4 Pliki specjalne (zwykle znajdujące się w /dev) 5 Formaty plików i konwencje, np. /etc/passwd 6 Gry 7 Różne ( w tym pakiety makr i konwencje), np. man(7), groff(7) 8 Polecenia administracyjne systemu (zwykle tylko dla roota) 9 Procedury jądra [Niestandardowe]

Strona podręcznika jest tworzona przy użyciu bardzo starego języka znaczników roff. Zawiera polecenia (znaczniki odczytu) dla różnych tytułów i sekcji.

  • .TH – To powinno być pierwsze polecenie w pliku man. Służy do określenia nagłówka tytułu strony podręcznika.
  • .CII - Podtytuł.
  • .B – Służy do wyświetlania tekstu obok pogrubioną czcionką.
  • .TP – Służy do wyświetlania informacji o argumencie (fladze) polecenia.
  • .BR – Służy do wyświetlania tekstu pogrubioną czcionką i zwykłą czcionką rzymską.

Poniżej znajduje się strona podręcznika do mojego programu, stworzona przy użyciu tylko powyższych (prostych) poleceń roff.

.TH test.sh 1 .SH NAZWA test.sh \- Drukuj Witam lub pa .SH SKŁADNIA .B test.sh [h] [b] .SH OPIS .B test.sh To jest przykładowy skrypt, który robi tylko 2 rzeczy . Wypisuje "Hello", jeśli argumentem jest 'h' lub wypisuje "Bye", jeśli argumentem jest 'b' .SH OPTIONS .TP .BR h Print Witaj .TP .BR b Print Bye

Zapisz plik naciskając najpierw WYJŚCIE klucz, a następnie wpisz :wq aby zapisać plik i wyjść z konsoli vima.

Przetestuj stronę podręcznika, którą właśnie stworzyliśmy, używając poniższego polecenia:

mężczyzna ./test.1

Więcej informacji na temat Człowiek użycie, bieganie man-strony podręcznika polecenie w terminalu.

? Wskazówka

To jest podstawowa składnia do pisania stron podręcznika. Aby to ułatwić, możesz użyć narzędzi, takich jak txt2man, przekonwertować plik w jakimś formacie języka znaczników na format roff.