[ powrót ] [ Spis treści ] [ 1 ] [ 2 ] [ 3 ] [ 4 ] [ 5 ] [ 6 ] [ 7 ] [ 8 ] [ 9 ] [ 10 ] [ dalej ]

Podręcznik dla nowych opiekunów pakietów Debiana
Część 5 - Inne pliki z katalogu debian/


Jak zobaczysz, w katalogu debian/ znajdują się jeszcze inne różne pliki. Większość z nich kończy się przyrostkiem `.ex', oznaczającym, że są to przykłady. Przyjrzyj im się wszystkim. Jeśli chcesz lub potrzebujesz użyć którejś ich funkcjonalności, to:

Niektóre z tych plików, najczęściej używane, są wyjaśnione w poniższych sekcjach.


5.1 Plik `README.Debian'

W tym pliku powinny być udokumentowane dodatkowe szczegóły lub rozbieżności pomiędzy oryginalnym pakietem i Twoją "zdebianizowaną" wersją.

Program dh_make tworzy domyślny plik README.Debian, który jest podobny do tego poniżej:

     gentoo for Debian
     -----------------
     
     <possible notes regarding this package - if none, delete this file>
     
      -- Josip Rodin <joy-mg@debian.org>, Wed, 11 Nov 1998 21:02:14 +0100

Ponieważ nie musimy niczego umieszczać w tym pliku, to możemy go skasować.


5.2 Plik `conffiles.ex'

Jedną z najbardziej irytujących rzeczy związanych z oprogramowaniem jest to, że po poświęceniu dużej ilości czasu i wysiłku na dostosowaniu programu, jego aktualizacja wszystko "zadeptuje". Debian rozwiązał ten problem przez "znakowanie" plików konfiguracyjnych. Zatem, jeśli uaktualniasz program do nowszej wersji, to zostaniesz zapytany o to czy chcesz zachować swoją starą konfigurację, czy nie.

Aby to uzyskać, musisz wprowadzić pełną ścieżkę do każdego pliku konfiguracyjnego (każda ścieżka w osobnej linii) do pliku nazwanego conffiles. Zwykle pliki te są umieszczone w katalogu /etc. Program gentoo ma jeden taki plik, /etc/gentoorc, zatem podamy ścieżkę do niego w pliku conffiles.

Jeśli Twój program używa plików konfiguracyjnych, ale sam zmienia ich zawartość, to najlepiej będzie nie umieszczać ich w pliku conffiles, ponieważ program dpkg będzie za każdym razem prosił użytkowników o weryfikację zmian.

Jeśli program, który pakujesz, wymaga do działania od każdego użytkownika modyfikacji pliku konfiguracyjnego, to również powinieneś zastanowić się nad rezygnacją z umieszczania go w pliku conffiles.

Przykładowe pliki konfiguracyjne możesz znaleźć w skryptach opiekuna pakietu. Więcej szczegółów na ich temat zamieszczono w sekcji Pliki `postinst.ex', `preinst.ex', `postrm.ex', `prerm.ex', Rozdział 5.12.

Jeśli Twój program nie posiada plików konfiguracyjnych, to możesz bez obaw wykasować plik conffiles z katalogu debian/.


5.3 Plik `cron.d.ex'

Jeśli Twój pakiet do prawidłowego działania wymaga regularnie wykonywanych zadań, to możesz do tego celu wykorzystać właśnie plik cron.d.

Zwróć uwagę, iż to nie obejmuje zagadnień związanych z "obracaniem" plików dziennika. Więcej informacji na ten temat znajdziesz na stronach podręcznika dh_installlogrotate(1) i logrotate(8).

Jeśli nie potrzebujesz tego pliku, to usuń go.


5.4 Plik `dirs'

Plik ten określa katalogi, które są potrzebne, ale których normalna procedura instalacyjna (make install) nie tworzy. Domyślnie, plik ten wygląda następująco:

     usr/bin
     usr/sbin

Zwróć uwagę, iż przed nazwami katalogów nie występują znaki ukośników (`/'). Normalnie zmienilibyśmy ją w następujący sposób:

     usr/bin
     usr/man/man1

ale ponieważ katalogi te są tworzone przez plik Makefile, to nie potrzebujemy pliku `dirs' i możemy go usunąć.


5.5 Plik `docs'

Ten plik określa nazwy plików z dokumentacją, którą program dh_installdocs zainstaluje dla nas w tymczasowym katalogu.

Domyślnie, obejmuje to także istniejące już w katalogu głównym ze źródłami programu takie pliki, jak "BUGS", "README*", "TODO", itd.

Dla programu gentoo dołączyłem również inne pliki:

     BUGS
     CONFIG-CHANGES
     CREDITS
     ONEWS
     README
     README.gtkrc
     TODO

Zamiast podawać listę plików możemy również użyć ich nazw jako argumentów wejściowych dla programu dh_installdocs wywoływanego w pliku rules:

     dh_installdocs BUGS CONFIG-CHANGES CREDITS ONEWS README \
                    README.gtkrc TODO

Może się tak zdarzyć, że będziesz mieć żadnego z tych plików w źródłach Twojego pakietu. W takim przypadku możesz bezpiecznie usunąć ten plik. Nie usuwaj jedynie wywołania programu dh_installdocs z pliku rules, ponieważ jest on używany również do instalacji pliku copyright i kilku innych rzeczy.


5.6 Plik `emacsen-*.ex'

Jeśli Twój pakiet zawiera pliki Emacsa, które mogą być skompilowane do kodu bajtowego w czasie instalacji, to możesz użyć tych plików właśnie w tym celu.

Pliki te są instalowane w katalogu tymczasowym przez program dh_installemacsen(1), zatem jeśli chcesz go wywołać, to nie zapomnij odkomentować odpowiedniej linii w pliku rules.

Jeśli zaś nie potrzebujesz tych plików, to możesz je usunąć.


5.7 Plik `init.d.ex'

Jeśli Twój pakiet jest demonem, który musi być uruchamiany w czasie startu systemu, to znaczy, że nie posłuchałeś moich zaleceń we wstępie do tego podręcznika, nieprawdaż? :-)

Plik ten jest prostym szablonem skryptu umieszczanego w katalogu /etc/init.d/, zatem będziesz musiał nieźle go przerobić. Zostanie on zainstalowany w katalogu tymczasowym przez program dh_installinit(1).

Jeśli nie potrzebujesz tego pliku, to usuń go.


5.8 Pliki `manpage.1.ex', `manpage.sgml.ex'

Twój program/programy powinien/powinny mieć stronę podręcznika systemowego. Jeśli jeszcze jej nie ma, to możesz użyć tych plikó jako szablonów.

Strony podręcznika są zwykle napisane w formacie nroff(1). W formacie tym napisano właśnie przykładowy plik manpage.1.ex. Zobacz stronę podręcznika programu man(7), aby dowiedzieć się więcej na temat tworzenia stron podręcznika.

Jeśli zamiast formatu nroff wolisz pisać dokumenty w formacie SGML, to możesz wykorzystać szablon manpage.sgml.ex. Będziesz też musiał:

Pamiętaj o zmianie nazwy pliku na coś takiego jak gentoo.sgml!

Nazwa pliku ze stroną podręcznika systemowego powinna zawierać nazwę programu, który opisuje, zatem zmień ją z "manpage" na "gentoo". Nazwa tego pliku zawiera także przyrostek ".1", który mówi, że jest to strona komendy użytkownika. Upewnij się, do której sekcji powinna należeć strona Twojego pakietu. Poniżej zamieszczono listę wyjaśniającą przeznaczenie każdej sekcji:

     Sekcja  |          Opis           |          Uwagi
        1     Polecenia użytkownika     Wykonywalne komendy lub skrypty.
        2     Wywołania systemowe       Funkcje dostarczane przez jądro systemu.
        3     Wywołania biblioteczne    Funkcje z bibliotek systemowych.
        4     Pliki specjalne           Zwykle umieszczone w katalogu /dev.
        5     Formaty plików            Na przykład format pliku /etc/passwd.
        6     Gry                       Lub inne rozrywkowe programy.
        7     Pakiety z makrami         Takie jak makra programu man.
        8     Administracja systemem    Programy zwykle uruchamiane tylko przez
                                        administratora systemu.
        9     Procedury jądra           Niestandardowe wywołania i procedury
                                        wewnętrzne.

Zatem strona programu gentoo powinna się nazywać gentoo.1. Dla programów przeznaczonych dla systemu X11 możesz dodać "x" do numeru sekcji, na przykład gentoo.1x. Ponieważ w oryginalnych źródłach nie było strony podręcznika `gentoo.1', to napisałem ją sam, używając informacji znalezionych w przykładach i dokumentacji dołączonej do źródeł.


5.9 Plik `menu.ex'

Użytkownicy systemu X Window zwykle posługują się menadżerami okien, umożliwiającymi uruchamianie programów poprzez rozwijalne menu, które można dostosowywać do własnych potrzeb. Jeśli zainstalowali oni pakiet menu, to zostanie dla nich stworzony zestaw menu służący do uruchamiania programów w systemie.

Poniżej pokazano plik menu.ex, domyślnie utworzony przez program dh_make:

     ?package(gentoo):needs=X11|text|vc|wm section=Apps/see-menu-manual\
       title="gentoo" command="/usr/bin/gentoo"

Pierwszym polem po znaku dwukropka jest pole "needs", które określa jakiego rodzaju interfejsu wymaga program. Zmień je na jedną z wymienionych możliwości, na przykład "text" lub "X11".

Następnym polem jest "section", które mówi w jakim menu i podmenu powinien znaleźć się wpis z programem gentoo. Aktualną listę sekcji można znaleźć na stronie /usr/share/doc/debian-policy/menu-policy.html/ch2.html#s2.1

Trzecie pole "title" to nazwa programu. Jeśli chcesz, to możesz rozpocząć je od wielkiej litery. Powinno one być krótkie.

Wreszcie pole "command" to nazwa komendy, która uruchamia program.

Po zmianach wpis do menu wygląda następująco:

     ?package(gentoo): needs=X11 section=Apps/Tools title="Gentoo" command="gentoo"

Możesz również dodać inne pola, na przykład "longtitle", "icon", "hints", itd. Więcej informacji możesz znaleźć na stronach podręcznika menufile(5), update-menus(1) i w katalogu /usr/share/doc/debian-policy/menu-policy.html/.


5.10 Plik `watch.ex'

Możesz użyć tego pliku jako dodatek do programów uscan(1) i uupdate(1) zawartych w pakiecie devscripts, aby obserwować stronę, z której pobrałeś oryginalne źródła.

Poniżej pokazano to, co umieściłem w tym pliku:

     # watch control file for uscan
     # Site              Directory    Pattern                 Version    Script
     ftp.obsession.se    /gentoo      gentoo-(.*)\.tar\.gz    debian     uupdate

Wskazówka: połącz się z Internetem i próbuj uruchomić program "uscan" w katalogu, w którym stworzyłeś plik `watch'. Przeczytaj również strony podręczników! :)


5.11 Plik `ex.package.doc-base'

Jeśli Twój pakiet ma dokumentację w postaci innej niż strony podręcznika i dokumentacja przeglądana za pomocą programu "info", to powinieneś użyć pliku `doc-base', aby ją zarejestrować. Użytkownik będzie mógł ją znaleźć, na przykład za pomocą programu dhelp(1), dwww(1) lub doccentral(1).

Na ogół obejmuje to pliki HTML, PS i PDF umieszczone w katalogu /usr/share/doc/nazwa_pakietu/.

Plik gentoo.doc-base dla programu gentoo wygląda następująco:

     Document: gentoo
     Title: Gentoo Manual
     Author: Emil Brink
     Abstract: This manual describes what Gentoo is, and how it can be used.
     Section: Apps/Tools
     
     Format: HTML
     Index: /usr/share/doc/gentoo/html/index.html
     Files: /usr/share/doc/gentoo/html/*.html

Informacje na temat formatu tego pliku znajdziesz na stronie podręcznika install-docs(8) oraz w podręczniku doc-base (katalog /usr/share/doc/doc-base/doc-base.html/).


5.12 Pliki `postinst.ex', `preinst.ex', `postrm.ex', `prerm.ex'

Pliki te są nazywane skryptami opiekuna. Umieszczone są one w obszarze kontrolnym pakietu i uruchamiane przez program dpkg, gdy Twój pakiet jest instalowany, uaktualniany do nowszej wersji lub usuwany.

Na razie powinieneś/powinnaś unikać ręcznych modyfikacji tych skryptów, ponieważ często są one skomplikowane. Więcej informacji znajdziesz w podręczniku Polityki Debiana, w rozdziale 6. Zerknij także na przykładowe pliki dostarczone przez program dh_make.


[ powrót ] [ Spis treści ] [ 1 ] [ 2 ] [ 3 ] [ 4 ] [ 5 ] [ 6 ] [ 7 ] [ 8 ] [ 9 ] [ 10 ] [ dalej ]

Podręcznik dla nowych opiekunów pakietów Debiana

wersja oryginału: 1.2, 6 kwietnia 2002. wersja tłumaczenia: 1.2.2, 17 marca 2004

Josip Rodin joy-mg@debian.org
polskie tłumaczenie: Paweł Tęcza ptecza@debianusers.pl
korekta tłumaczenia: Marcin Owsiany porridge@debian.org