Najdokładniejszą dokumentacją we FreeBSD jest dokumentacja
systemowa. Dla prawie każdego dostępnego w systemie programu
przygotowana jest krótka instrukcja obsługi, omawiająca podstawy
jego działania i rozmaite opcje. Dokumentację możemy przeglądać
przy pomocy polecenia man. Korzystanie z tego
polecenia jest bardzo proste:
%man polecenie
polecenie jest nazwą polecenia, o którym chcemy
uzyskać informacje. Na przykład, aby dowiedzieć się czegoś na temat
polecenia ls wpisujemy:
%man ls
Dokumentacja systemowa podzielona jest na ponumerowane części:
Polecenia dostępne dla użytkowników.
Funkcje systemowe i kody błędów.
Funkcje z bibliotek języka C.
Sterowniki urządzeń.
Formaty plików.
Gry i inne rozrywki.
Różne informacje.
Polecenia służące do zarządzania systemem.
Informacje dla programistów jądra.
Niekiedy takie samo zagadnienie może pojawić się w kilku
częściach dokumentacji. Na przykład istnieje polecenie
chmod, oraz funkcja systemowa
chmod(). W taki wypadku możemy wybrać
interesującą nas część dokumentacji, podając jej numer jako
parametr polecenia man:
%man 1 chmod
W efekcie pokazana zostanie dokumentacja polecenia chmod.
Zgodnie z przyjętą konwencją, numer odpowiedniej części dokumentacji
podawany jest w nawiasach, tak więc chmod(1) odpowiada poleceniu
chmod, natomiast chmod(2) odpowiada funkcji
systemowej.
W opisany powyżej sposób możemy dowiedzieć się, jak korzystać
z danego polecenia, jeśli znamy jego nazwę. Co zrobić, jeśli nie
możemy sobie przypomnieć nazwy polecenia? Otóż, man
potrafi również wyszukiwać wybranych słów kluczowych w opisach
poleceń, służy do tego opcja -k:
%man -k mail
Wpisanie takiego polecenia spowoduje wyświetlenie listy
poleceń, których opisy zawierają słowo kluczowe "mail".
Takie działanie jest równoważne skorzystaniu z polecenia
apropos.
Jeśli więc, przeglądając zawartość katalogu
/usr/bin, zastanawiamy się, do czego
właściwie służą znajdujące się tam polecenia, możemy wpisać:
%cd /usr/bin%man -f *
lub
%cd /usr/bin%whatis *
W obu przypadkach efekt będzie taki sam.
Do FreeBSD dołączonych jest wiele programów i narzędzi
stworzonych przez Free Software Foundation (FSF). Prócz
dokumentacji systemowej, do tych programów dołączone są
bardziej rozbudowane dokumenty hipertekstowe, zwane plikami
info. Można je przeglądać poleceniem
info, lub trybem info emacsa,
o ile emacs został zainstalowany.
By skorzystać z polecenia info(1), wpisujemy:
%info
Krótkie wprowadzenie pojawia się po wpisaniu h.
Spis poleceń jest dostępny po wpisaniu ?.
All FreeBSD documents are available for download at https://download.freebsd.org/ftp/doc/
Questions that are not answered by the
documentation may be
sent to <freebsd-questions@FreeBSD.org>.
Send questions about this document to <freebsd-doc@FreeBSD.org>.