NAZWA¶
install-docs - zarządzanie dokumentacją Debiana
SKŁADNIA¶
install-docs [opcje] -i,--install | -r,--remove | -c,--check plik [ plik ... ]
install-docs [opcje] -I,--install-all | -C,--install-changed | -R,--remove-all
install-docs [opcje] -s,--status docid [ docid ... ]
install-docs [opcje] --dump-db nazwa_db
install-docs -h,--help | -V,--version
OPIS¶
install-docs jest narzędziem pozwalającym opiekunom
pakietów Debiana na rejestrowanie dokumentacji w różnych
systemach. Obecnie wspiera przeglądarki
dhelp,
dwww,
doc-central oraz
scrollkeeper.
Ta strona podręcznika ekranowego zawiera podstawowe wskazówki
dotyczące używania
install-docs. Pełny opis
programu wraz z opisem składni składni pliku konfiguracyjnego
można znaleźć w dokumentacji dołączonej do
pakietu.
OPCJE¶
- -v, --verbose
- Tryb gadatliwy.
- -d, --debug
- Wyświetla komunikaty diagnostyczne.
- --no-update-menus
- Nie uruchamia dwww-build-menu(8), dhelp_parse(8), ani
scrollkeeper-update(8).
- --rootdir katalog
- Ustawia główny katalog na katlaog, zamiast
używać ` /'. Użyteczne i poprawne tylko w
przypadku akcji --check.
AKCJE¶
Poniżej podano listę akcji obsługiwanych przez
install-docs. Programowi można podać tylko jedną
akcję. Ponadto akcja ta łącznie z jej argumentami musi
być przekazana jako ostatnia opcja linii poleceń.
Każdy argument
plik powinien być pełną
ścieżką do pliku kontrolnego doc-base(t.j.
"/usr/share/doc-base/jakiś_plik" lub
"/etc/doc-base/documents/jakiś_plik"), a każde
docid powinno być identyfikatorem dokumentu (Identyfikatory
dokumentów są ustawiane w polu "Document" pliku
kontrolnego i zazwyczaj są takie same jak nazwa pakietu).
Jeżeli
plik lub <docid> jest równe
"
-" (znak minusa), to lista argumentów jest
odczytywana ze standardowego wejścia (każda nazwa pliku lub
każde id dokumentu w oddzielnej linii).
- -i plik [plik ...], --install plik
[plik ...]
- Instaluje dokumentację wymienioną w pliku kontrolnym
plik.
- -r plik [plik ...], --remove plik
[plik ...]
- Wyrejestrowuje dokumentację wymienioną w pliku kontrolnym
plik.
- -c plik [plik ...], --check plik
[plik ...]
- Sprawdza poprawność pliku kontrolnego plik i
wyświetla listę znalezionych problemów. Użyta
z opcją --verbose podaje lokalizacje
błędów i ostrzeżeń. Jeśli podano
także --rootdir, to argument tej opcji zostanie
dołączony do nazw plików wymienionych w polach
"Files" i "Index" pliku.
- -R, --remove-all
- Wyrejestrowuje wszystkie zarejestrowane dokumenty.
- -I, --install-all
- (Ponownie) rejestruje wszystkie dokumenty z katalogów
/usr/share/doc-base i /etc/doc-base/documents.
- -C, --install-changed
- Porównuje zawartość katalogów
/usr/share/doc-base i /etc/doc-base/documents z bazą
danych zarejestrowanych dokumentów i wyrejestrowuje usunięte
pliki oraz (ponownie) rejestruje pliki zmienione lub dodane.
- -s docid [docid ...], --status docid
[docid ...]
- Wyświetla stan dokumentu określonego przez
docid.
- -L docid [docid ...], --listfiles docid
[ docid ...]
- Opcja przestarzała. Nie robi nic.
- --dump-db nazwa_db
- Wypisuje - w celu debugowania programu - zawartość
wewnętrznych baz danych. nazwa_db może być
albo files.db, albo status.db.
- -h, --help
- Wyświetla krótki komunikat pomocy.
- -V, --version
- Wyświetla informacje o wersji programu.
KOMPATYBILNOŚĆ Z POPRZEDNIMI WERSJAMI¶
Następujące właściwości zostały dodane
w wersji 0.8.4 programu, opiekunowie pakietów powinni dodać
odpowiednie linie "
Conflicts" lub
"
Depends", jeśli planują ich
używać w skryptach pakietów:
- •
- obsługa wielu argumentów akcji -i oraz
-r,
- •
- czytanie argumentów ze standardowego wejścia,
- •
- akcje -I, --install-all, -R, ---remove-all,
-c, --check,
- •
- opcje -d, --debug, -h, --help.
Opcje
-C,
--install-changed,
--dump-db,
-V,
--version zostały dodane w wersji 0.8.12.
PLIKI¶
- /usr/share/doc-base/
- Lokalizacja plików kontrolnych doc-base dostarczanych przez
pakiety.
- /etc/doc-base/documents/
- Lokalizacja plików kontrolnych doc-base dostarczanych przez
lokalnego administratora.
- /var/lib/doc-base/info/documents/
- Lokalizacja zarejestrowanych plików kontrolnych.
- /var/lib/doc-base/info/status.db
- Stany zarejestrowanych dokumentów.
- /var/lib/doc-base/info/files.db
- Znaczniku czasowe i identyfikatory zarejestrowanych plików
doc-base.
- /var/lib/doc-base/omf/
- Lokalizacja wygenerowanych plików OMF scrollkeepera. Uwaga:
/usr/share/omf/doc-base powinien być dowiązaniem
symbolicznym wskazującym na ten katalog.
BŁĘDY¶
Patrz <
http://bugs.debian.org/doc-base>.
ZOBACZ TAKŻE¶
dhelp(1),
doccentral(1),
dwww(7),
scrollkeeper(7),
Podręcznik doc-base
/usr/share/doc/doc-base/doc-base.html/index.html
AUTOR¶
Program napisał Christian Schwarz <schwarz@debian.org> dla systemu
Debian GNU/Linux; kolejnym opiekunem był Adam Di Carlo
<aph@debian.org>. Robert Luberda <robert@debian.org> zajmuje
się nim obecnie i go rozszerza o nowe funkcjonalności.
Ten program został napisany dla pożytku całej
społeczności użytkowników i opiekunów
Debiana. Aby zaangażować się w rozwój programu,
prosimy dołączyć do listy dyskusyjnej
<debian-doc@lists.debian.org>.