[ powrót ] [ Spis treści ] [ 1 ] [ 2 ] [ 3 ] [ 4 ] [ 5 ] [ 6 ] [ 7 ] [ 8 ] [ 9 ] [ 10 ] [ A ] [ dalej ]
Jak zobaczysz, w katalogu debian/ znajdują się jeszcze różne inne pliki, większość z nich kończy się przyrostkiem `.ex', oznaczającym, że są to przykłady. Przyjrzyj się im wszystkim. Jeśli chcesz lub musisz użyć którejś z ich funkcjonalności, to:
zajrzyj do odpowiedniej dokumentacji (wskazówka: podręcznik Polityki Debiana)
jeśli to konieczne, zmodyfikuj zawartość plików według potrzeb
usuń z ich nazwy przyrostek `.ex', jeśli taki posiadają
usuń z ich nazwy przedrostek `ex.', jeśli taki posiadają
zmodyfikuj plik `rules' według potrzeb
Niektóre z tych plików, najczęściej używane, są objaśnione w poniższych sekcjach.
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 wygląda jakoś tak:
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, możemy go skasować.
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 dostosowanie 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 (zwykle znajdują się w katalogu /etc), jednego w każdej linii, w pliku nazwanym conffiles. Program gentoo ma jeden plik konfiguracyjny, /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 od każdego użytkownika modyfikacji pliku konfiguracyjnego, aby w ogóle zadziałać, to również powinieneś zrezygnować 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 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/.
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ę, że to nie obejmuje zagadnień związanych z rotacją plików
logów. Więcej informacji na ten temat znajdziesz na stronach podręcznika
dh_installlogrotate(1)
i logrotate(8)
.
Jeśli nie potrzebujesz tego pliku, usuń go.
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 go w następujący sposób:
usr/bin usr/man/man1
ale ponieważ katalogi te są tworzone przez Makefile, to nie potrzebujemy pliku `dirs' i możemy go usunąć.
Ten plik określa nazwy plików z dokumentacją, którą program dh_installdocs zainstaluje w tymczasowym katalogu.
Domyślnie obejmuje to także pliki istniejące już w katalogu głównym ze źródłami programu, takie jak "BUGS", "README*", "TODO" itp.
Dla programu gentoo dołączyłem również inne pliki:
BUGS CONFIG-CHANGES CREDITS ONEWS README README.gtkrc TODO
Możemy też usunąć ten plik i, zamiast podawać listę plików, 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 nie będziesz mieć żadnego z tych plików w źródłach Twojego pakietu. W takim przypadku możesz bezpiecznie usunąć plik docs. Nie usuwaj jednak wywołania programu dh_installdocs z pliku rules, ponieważ jest on używany również do instalacji pliku copyright i innych rzeczy.
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ć, nie
zapomnij odkomentować odpowiedniej linii w pliku rules.
Jeśli zaś nie potrzebujesz tych plików, możesz je usunąć.
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ł znacznie go przerobić.
Zostanie on zainstalowany w katalogu tymczasowym przez program
dh_installinit(1)
.
Jeśli nie potrzebujesz tego pliku, usuń go.
Twój program(y) powinien mieć stronę podręcznika systemowego. Jeśli jeszcze jej nie ma, to możesz użyć tych plików 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)
, jest tam krótki
opis, jak poprawiać tego typu pliki.
Jeśli zamiast formatu nroff wolisz pisać dokumenty w formacie SGML, to możesz wykorzystać szablon manpage.sgml.ex. W takim przypadku musisz:
zainstalować pakiet docbook-to-man
dopisać docbook-to-man do linii Build-Depends w pliku control
usunąć znak komentarza przed wywołaniem programu docbook-to-man w regule `build' pliku rules
Pamiętaj o zmianie nazwy pliku na coś w stylu gentoo.sgml!
Docelowa 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 z sekcji poleceń użytkownika. Upewnij się, do której sekcji powinna należeć strona Twojego pakietu. Poniżej zamieszczono krótką listę sekcji podręcznika:
Sekcja | Opis | Uwagi 1 Polecenia użytkownika Wykonywalne komendy lub skrypty. 2 Wywołania systemowe Funkcje jądra systemu. 3 Wywołania biblioteczne Funkcje 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 programy rozrywkowe. 7 Pakiety makr Takie jak makra programu man. 8 Administracja systemem Programy zwykle uruchamiane tylko przez administratora. 9 Procedury jądra Niestandardowe wywołania i procedury wewnętrzne.
Zatem podręcznik programu gentoo powinien nazywać się gentoo.1. Ponieważ w oryginalnych źródłach nie było strony podręcznika `gentoo.1', napisałem ją sam, używając informacji znalezionych w przykładach i dokumentacji dołączonej do źródeł.
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 utworzony 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
.
Pole "title" to nazwa programu. Jeśli chcesz, możesz rozpocząć ją od wielkiej litery. Powinna być krótka.
Wreszcie pole "command" to nazwa polecenia, które 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/.
Plik ten jest używany do konfigurowania programów uscan(1)
i
uupdate(1)
(zawartych w pakiecie devscripts
). Są
one używane do sprawdzania strony internetowej, z której pobrałeś źródła
dla swojego pakietu.
W tym pliku umieściłem:
# 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 spróbuj uruchomić program "uscan" w katalogu, w którym stworzyłeś plik `watch'. I czytaj strony podręczników! :)
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ą wtedy znaleźć, na przykład za pomocą
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/
).
Więcej szczegółów nt. instalowania dokumentacji w sekcji Instalacja w podkatalogu, Rozdział 3.1.
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ś 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 wygenerowane przez program dh_make.
[ powrót ] [ Spis treści ] [ 1 ] [ 2 ] [ 3 ] [ 4 ] [ 5 ] [ 6 ] [ 7 ] [ 8 ] [ 9 ] [ 10 ] [ A ] [ dalej ]
Podręcznik dla nowych opiekunów pakietów Debiana
wersja oryginału: 1.2.11, 12-01-2007, wersja tłumaczenia: 1.2.5, 27-09-2007joy-mg@debian.org
ptecza@debianusers.pl
porridge@debian.org
wojtekz@comp.waw.pl