Konwencje zastosowane w dokumencie, Formatowanie tekstu, Konwencje składni poleceń – Dell Brocade Adapters Instrukcja Obsługi

Strona 20

Advertising
background image

xx

Karty Brocade — Podr

ę

cznik instalacji

53-1002144-01

Konwencje zastosowane w dokumencie

W niniejszym rozdziale opisano konwencje formatowania tekstu oraz formatów ważnych ostrzeżeń
i uwag, które zostały zastosowane w niniejszym dokumencie.

Formatowanie tekstu

Zastosowane konwencje formatowania tekstu:

tekst pogrubiony

Oznacza nazwy poleceń
Oznacza nazwy elementów interfejsu graficznego,
którymi może sterować użytkownik
Oznacza słowa kluczowe i operatory
Oznacza tekst do wprowadzenia w polach interfejsu
graficznego lub wierszu polecenia

tekst pisany

Oznacza wyróżnienie fragmentu tekstu

kursywą

Oznacza zmienne
Oznacza ścieżki i adresy internetowe
Oznacza tytuły dokumentów

tekst

kodu

Oznacza wyniki poleceń wyświetlane w wierszu polecenia
Oznacza przykłady składni poleceń

Aby zapewnić lepszą czytelność, nazwy poleceń występujące w akapitach opisowych niniejszego
przewodnika są pisane wielkimi i małymi literami, na przykład: switchShow. W rzeczywistych
przykładach polecenia są zazwyczaj pisane małymi literami.

Konwencje składni poleceń

Zastosowane konwencje składni poleceń:

polecenie

Nazwy poleceń są pisane czcionką pogrubioną.

--

opcja, opcja

Opcje poleceń są pisane czcionką pogrubioną.

-

argument, arg

Argumenty poleceń.

[ ]

Elementy opcjonalne.

zmienna

Nazwy zmiennych są pisane kursywą. Na stronach pomocy nazwy zmiennych
są podkreślone lub ujęte w nawiasy ostrokątne <>.

....

Powtórzenie poprzedniego elementu, na przykład: „składowa[;składowa...]”

wartość

Stałe wartości występujące po argumentach są pisane czcionką zwykłą.
Przykładowo

--

show WWN

|

Operator logiczny. Podane elementy są wyłączne. Przykład:

--

show

-

mode

egress | ingress

Advertising