Leksykon Linuksa — Anatomia strony podręcznika

Strony M są zazwyczaj podzielone na serie sekcji szczegółowo opisujących nazwę i opis, zastosowanie i zastrzeżenia. Strony podręcznika mogą być trudne do odczytania, ale są cennymi zasobami, które można wykorzystać w mgnieniu oka i nie wymagają nawet Internetu.

IMIĘ
Pierwszy to nagłówek nazwy, a to wszystko podsumowuje. Ta sekcja zawiera nazwę narzędzia, a także krótki opis.

STRESZCZENIE
Istnieją różne stopnie czytelności od strony podręcznika do strony podręcznika, ale jedno jest pewne, najtrudniejszą częścią jest zazwyczaj rozszyfrowanie włochatego streszczenia. Istnieje kilka konwencji wskazywania wymaganych informacji dla danego polecenia. Konwencje te składają się z różnych nawiasów i nawiasów, a także innych form zapisu. Wszystkie te różne konwencje mogą być niezwykle mylące dla początkującego i zniechęcające dla kogoś, kto jest doświadczony, ale nie jest obeznany z podręcznikami. Poniżej podzielimy ten bełkot na przyswajalne zasady.

Te reguły są dość proste, ale stają się trudniejsze, a nawet onieśmielające, gdy są używane w długich definicjach funkcji, zwłaszcza gdy są zagnieżdżone. Tak więc przyjrzymy się niektórym zagnieżdżeniom poniżej, aby zbudować to, co podzieliliśmy.

tar {A|c|d|r|t|u|x}[GnSkUWOmpsMBiajJzZhPlRvwo] [ ARG …]

Polecenie tar ma wiele opcji. Widzimy nazwę polecenia smoły pogrubioną, ponieważ należy ją wpisać tak, jak pokazano. Następnie widzimy otwarte nawiasy klamrowe z opcjami oddzielonymi rurkami wskazującymi, że jesteśmy ograniczeni do nich i musimy wybrać tylko jedną. Dalej są opcjonalne flagi, możemy użyć dowolnej liczby, chociaż mogą nie działać razem, dalsza lektura strony podręcznika rzuci światło na potencjalne konflikty opcji. I na koniec mamy powtarzalny argument, w przypadku tar jest to dla plików, na których operujesz.

su [opcje] [-] [ użytkownik [ argument …]]

Ponownie widzimy su bold, ponieważ jest to nazwa polecenia. Po drugie, widzimy, że w rzeczywistości żadne flagi nie są określone, tylko że są one opcjonalne. Po trzecie, jest określona pojedyncza flaga, ale jest ona również opcjonalna. Na koniec widzimy opcjonalny argument, który jest powtarzalny wewnątrz opcjonalnego argumentu. Teraz to, co kiedyś wyglądało bardzo tajemniczo, ma więcej sensu.

whois [{-h|–host } HOST ] [{-p|–port} PORT ] [ -abBcdGHKlLmMrRx ] [-g ŹRÓDŁO:PIERWSZY-OSTATNI ] [-i ATR [, ATR ]…] [-s ŹRÓDŁO [, ŹRÓDŁO ]…] [-T TYP [, TYP ]…] [–pełny] OBIEKT

To jest szczególnie gęsty. Skopiuj go do swojego ulubionego edytora tekstu i dodaj tam dodatkowe spacje, jeśli pomoże ci to przeczytać. Po zeskanowaniu powinieneś zacząć widzieć kilka wzorów. Części hosta i portu używają tego samego formatowania dla krótkiej i długiej postaci opcji, po której następuje argument tej opcji, chociaż obie są same w sobie opcjonalne. Następnie widzimy ciąg opcjonalnych flag. Następny fragment o źródłach od pierwszego do ostatniego to składnia oczekiwana przez whois, która jest wyjaśniona w dalszej części strony podręcznika. Teraz widzimy tę trójkę opcjonalnych flag, które przyjmują albo pojedynczy argument, albo opcjonalne powtarzające się argumenty, jest to rodzaj łączenia konwencji, który na początku może być bardzo trudny do pełnego zrozumienia. Wreszcie istnieje opcja gadatliwa i obiekt (host/domena).

I tak należy czytać streszczenie strony podręcznika. Istnieje kilka innych konwencji, ale są one zbyt niejasne, aby je omówić w tym artykule.

OPIS
Zazwyczaj jest to miejsce, w którym nakreślone jest przeznaczenie programu lub narzędzia. Niektóre podręczniki będą pod tym nagłówkiem znacznie bardziej szczegółowe niż inne.

OPCJE
Pamiętasz te wszystkie flagi i różne argumenty, które mogą być opcjonalne lub obowiązkowe? Tutaj wszyscy się wyjaśniają. Zwykle są tutaj dobre informacje i często tam znajdziesz konwencję <argument>, wskazującą, że dana flaga wymaga odpowiedniego argumentu. Czasami okaże się, że opcje będą znajdować się w części opisowej, ponieważ nie ma twardych reguł definiujących strony podręcznika, a jedynie konwencje i chęć przestrzegania standardów.

PRZYKŁADY
Jest to jedna z najbardziej poręcznych części, która niestety nie jest zawarta we wszystkich instrukcjach. Przekonasz się również, że ilość informacji i liczba przykładów znacznie się różni, a nie wszystkie przykłady faktycznie pomagają w korzystaniu z polecenia.

Dodatkowo regularnie znajdziesz sekcje dla autora, informacje o prawach autorskich, zgłaszanie błędów, a także (a propos).

Poza tym istnieją formalnie zdefiniowane sekcje stron podręcznika, jak zdefiniowano poniżej.

Wiele poleceń nie ma podręczników w więcej niż jednej sekcji, ale dla tych, które mają, lub dla niektórych, które mogą być niejednoznacznie nazwane, możesz określić sekcję, jak w poniższym przykładzie.

Polecenia to nie jedyne rzeczy, które mają instrukcje, jak widać z dostępnych sekcji. Wywołania systemowe, pliki konfiguracyjne i urządzenia specjalne mogą równie dobrze mieć odpowiednią stronę podręcznika. Ilość informacji o typowej instalacji Linuksa na stronach podręcznika jest niesamowita i to samo dotyczy innych systemów operacyjnych typu open source UNIX.

Jeśli okaże się, że strona podręcznika jest niewystarczająca i nadal nie rozumiesz polecenia, zawsze sprawdzaj online, ponieważ wiele osób oferuje dokładniejsze objaśnienia niektórych narzędzi, ale także wiele dystrybucji ma własne strony podręcznika dla różnych pakietów oprogramowania. Po stwierdzeniu, że czujesz się komfortowo z jakimś oprogramowaniem, ale nadal czujesz, że brakuje Ci instrukcji, zawsze możesz wnieść swój wkład, pisząc własne i przesyłając do odpowiedniego projektu. Dokumentacja jest często najbardziej zaniedbaną częścią projektów oprogramowania, więc nawet jeśli nie umiesz pisać kodu, możesz pisać podręczniki, artykuły Wiki i samouczki, aby pomóc innym.

Teraz, gdy znasz anatomię strony podręcznika, nie masz wymówki, jak tylko do RTFM (a to przeczytaj bezpłatną instrukcję dla osób poniżej 18 roku życia) ;)

Przeczytaj także: Leksykon Linux: Użyj polecenia Watch, aby uruchomić polecenie co X sekund