chiark / gitweb /
- Sec "Best practices for debian/control" added, Sec "Writing useful
[developers-reference.git] / common.ent
1 <!-- common entities file
2
3      Bits of text which are language independent.  In some cases it
4      makes sense to break these out because repetitively maintaining
5      them in different translations of the Developer's Reference is
6      wasteful.  In other cases, the data is rather volatile and
7      breaking it out make maintenance easier.
8   -->
9
10 <!-- volatile information -->
11
12 <!entity number-of-pkgs "9000">
13 <!entity number-of-maintainers "800">
14
15 <!entity number-of-arches "12">
16
17 <!-- standard information -->
18 <!entity fsf-addr "Free Software Foundation,
19   Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA">
20 <!entity file-GPL "<file>/usr/share/common-licenses/GPL</file>">
21 <!entity debian-formal "Debian GNU/Linux">
22
23 <!--
24      URLs, Debian
25   -->
26 <!entity www-debian-org "www.debian.org">
27 <!entity ftp-debian-org "ftp.debian.org">
28 <!entity ftp-host "&ftp-debian-org;">
29 <!entity www-host "&www-debian-org;">
30 <!entity lists-host "lists.debian.org">
31 <!entity archive-host "archive.debian.org">
32 <!entity keyserver-host "keyring.debian.org">
33 <!entity packages-host "packages.debian.org">
34 <!entity bugs-host "bugs.debian.org">
35 <!entity pts-host "packages.qa.debian.org">
36 <!entity ftp-master-host "ftp-master.debian.org">
37 <!entity non-us-host "non-us.debian.org">
38 <!entity upload-queue "<ftppath>/pub/UploadQueue/</ftppath>">
39
40 <!entity url-debian-policy "http://&www-debian-org;/doc/debian-policy/">
41 <!entity url-perl-policy "http://&www-debian-org;/doc/packaging-manuals/perl-policy/">
42 <!entity url-emacs-policy "http://&www-debian-org;/doc/packaging-manuals/debian-emacs-policy">
43 <!entity url-java-policy "http://www.debian.org/doc/packaging-manuals/java-policy/">
44 <!entity url-libpkg-guide "http://www.netfort.gr.jp/~dancer/column/libpkg-guide/">
45
46 <!entity url-social-contract "http://&www-debian-org;/social_contract">
47 <!entity url-constitution "http://&www-debian-org;/devel/constitution">
48 <!entity url-dfsg "&url-social-contract;#guidelines">
49 <!entity url-debian-lists "http://&www-debian-org;/MailingLists/">
50 <!entity url-debian-lists-txt "http://&ftp-debian-org;/debian/doc/mailing-lists.txt">
51 <!entity url-debian-lists-subscribe "http://&www-debian-org;/MailingLists/subscribe">
52 <!entity url-lists-archives "http://&lists-host;/">
53 <!entity url-bts "http://&www-debian-org;/Bugs/">
54 <!entity url-bts-devel "&url-bts;Developer">
55 <!entity url-bts-control "&url-bts;server-control">
56 <!entity url-debian-mirrors "http://&www-debian-org;/distrib/ftplist">
57 <!entity url-debian-mirroring "http://&www-debian-org;/mirror/">
58 <!entity url-debian-ports "http://&www-debian-org;/ports/">
59 <!entity url-debian-port-lists "http://&lists-host;/ports.html">
60 <!entity url-wnpp "http://&www-debian-org;/devel/wnpp/">
61 <!entity url-devel-docs "http://&www-debian-org;/devel/">
62 <!entity url-vote "http://&www-debian-org;/vote/">
63 <!entity url-cvsweb "http://cvs.debian.org/">
64 <!entity url-devel-machines "http://db.debian.org/machines.cgi">
65 <!entity url-buildd "http://buildd.debian.org/">
66 <!entity url-lintian "http://lintian.debian.org/">
67 <!entity url-debian-qa "http://qa.debian.org/">
68 <!entity url-debian-db "https://db.debian.org/">
69 <!entity url-debian-db-mail-gw "http://db.debian.org/doc-mail.html">
70 <!entity url-debian-db-doc "http://db.debian.org/doc-general.html">
71 <!entity url-newmaint "http://&www-debian-org;/devel/join/newmaint">
72 <!entity url-newmaint-checklist "http://&www-debian-org;/devel/join/nm-checklist">
73 <!entity url-newmaint-db "http://nm.debian.org/">
74 <!entity url-newmaint-advocate "http://&www-debian-org;/devel/join/nm-advocate">
75 <!entity url-newmaint-amchecklist "http://&www-debian-org;/devel/join/nm-amchecklist">
76 <!entity url-newmaint-apply "http://nm.debian.org/newnm.php">
77 <!entity url-newmaint-id "http://&www-debian-org;/devel/join/nm-step2">
78 <!entity url-newmaint-guide "http://&www-debian-org;/doc/maint-guide/">
79 <!entity url-gpg-coord "http://nm.debian.org/gpg.php">
80 <!entity url-debian-security-advisories "http://&www-debian-org;/security/">
81 <!entity url-tech-ctte "http://&www-debian-org;/devel/tech-ctte">
82 <!entity url-ddpo "http://qa.debian.org/developer.php">
83
84 <!entity url-debian-keyring "http://&ftp-debian-org;/debian/doc/debian-keyring.tar.gz">
85 <!entity url-readme-non-us "http://&ftp-debian-org;/debian/README.non-US">
86 <!entity url-incoming "http://incoming.debian.org/">
87 <!entity url-testing-maint "http://www.debian.org/devel/testing">
88 <!-- deprecated -->
89 <!entity url-testing-faq "&url-testing-maint;">
90
91 <!entity us-upload-dir "<file>/org/ftp.debian.org/incoming/</file>">
92 <!entity non-us-upload-dir "<file>/org/non-us.debian.org/incoming/</file>">
93 <!entity url-chiark-readme "ftp://ftp.chiark.greenend.org.uk/pub/debian/private/project/README.how-to-upload">
94 <!entity url-upload-erlangen "ftp://ftp.uni-erlangen.de/pub/Linux/debian/UploadQueue/">
95 <!entity url-upload-samosa "ftp://samosa.debian.org/pub/UploadQueue/">
96 <!entity url-upload-jp "ftp://master.debian.or.jp/pub/Incoming/upload/">
97
98 <!entity url-sponsors "http://www.internatif.org/bortzmeyer/debian/sponsor/">
99
100 <!entity url-rules-files "http://people.debian.org/~srivasta/rules/">
101
102 <!entity url-debconf-l10n-help "http://&www-debian-org;/intl/l10n/templates/hints">
103
104 <!entity url-dmup "http://&www-debian-org;/devel/dmup">
105
106 <!entity url-i18n-doc-check "&url-cvsweb;boot-floppies/documentation/doc-check?rev=HEAD&amp;content-type=text/vnd.viewcvs-markup">
107
108 <!entity url-eg-desc-upstream-info "http://&packages-host;/unstable/text/docbook-dsssl.html">
109
110 <!-- 
111      URLs, non-debian
112   -->
113 <!entity url-gnu-manifesto "http://www.gnu.org/gnu/manifesto.html">
114 <!entity url-gpl "http://www.gnu.org/copyleft/gpl.html">
115 <!entity url-pgp-faq "http://www.cam.ac.uk.pgp.net/pgpnet/pgp-faq/">
116 <!entity url-rfc2440 "http://www.gnupg.org/rfc2440.html">
117 <!entity url-u.s.-export "http://www.bxa.doc.gov/Encryption/PubAvailEncSourceCodeNofify.html">
118 <!entity url-notification-of-export "http://www.bxa.doc.gov/Encryption/">
119 <!entity url-openprojects "http://www.freenode.net/">
120
121 <!-- Debian email addresses -->
122 <!entity email-listmaster "<email>listmaster@&lists-host;</email>">
123 <!entity email-debian-announce "<email>debian-announce@&lists-host;</email>">
124 <!entity email-debian-changes "<email>debian-changes@lists.debian.org</email>">
125 <!entity email-debian-devel "<email>debian-devel@&lists-host;</email>">
126 <!entity email-debian-devel-announce "<email>debian-devel-announce@&lists-host;</email>">
127 <!entity email-debian-devel-changes "<email>debian-devel-changes@lists.debian.org</email>">
128 <!entity email-debian-devel-req "<email>debian-devel-REQUEST@&lists-host;</email>">
129 <!entity email-debian-mentors "<email>debian-mentors@&lists-host;</email>">
130 <!entity email-debian-private "<email>debian-private@&lists-host;</email>">
131 <!entity email-debian-project "<email>debian-project@&lists-host;</email>">
132 <!entity email-debian-policy "<email>debian-policy@&lists-host;</email>">
133 <!entity email-debian-user "<email>debian-user@&lists-host;</email>">
134 <!entity orphan-address "&lt;packages@qa.debian.org&gt;">
135 <!entity email-debian-qa "<email>debian-qa@&lists-host;</email>">
136 <!entity email-debian-release "<email>debian-release@&lists-host;</email>">
137 <!entity email-debian-email "<email>debian-email@&lists-host;</email>">
138 <!entity email-debian-vote "<email>debian-vote@&lists-host;</email>">
139 <!entity email-debian-security-announce "<email>debian-security-announce@&lists-host;</email>">
140 <!entity email-debian-l10n-english "<email>debian-l10n-english@&lists-host;</email>">
141
142 <!entity email-new-maintainer "<email>new-maintainer@debian.org</email>">
143 <!entity email-debian-keyring "<email>keyring-maint@debian.org</email>">
144 <!entity email-debian-admin "<email>debian-admin@debian.org</email>">
145 <!entity email-ftpmaster "<email>ftpmaster@debian.org</email>">
146 <!entity email-override "<email>override-change@debian.org</email>">
147 <!entity email-wnpp "<email>wnpp@debian.org</email>">
148 <!entity email-bts-control "<email>control@bugs.debian.org</email>">
149 <!entity email-security-team "<email>team@security.debian.org</email>">
150
151 <!-- misc Debian info -->
152 <!entity file-mail-lists "<file>/usr/share/doc/debian/mailing-lists.txt</file>">
153 <!entity file-bts-mailing "<file>/usr/share/doc/debian/bug-log-mailserver.txt</file>">
154 <!entity file-bts-info "<file>/usr/share/doc/debian/bug-maint-info.txt</file>">
155 <!entity file-bts-docs "<file>/usr/share/doc/debian/bug-*</file>">
156 <!entity file-python-policy "<file>/usr/share/doc/python/python-policy.txt.gz</file>">
157 <!entity file-ocaml-policy "<file>/usr/share/doc/ocaml/ocaml_packaging_policy.gz</file>">
158 <!entity file-lisp-controller "<file>/usr/share/doc/common-lisp-controller/README.packaging</file>">
159 <!entity file-debian-private-archive "~debian/archive/debian-private/">
160 <!entity file-bpp-autotools "<file>/usr/share/doc/autotools-dev/README.Debian.gz</file>">
161
162 <!entity cron-bug-report '0 17 * * fri   echo "index maint <var>address</var>" | mail request@bugs.debian.org'>
163
164 <!entity control-file-fields "<list compact>
165               <item><tt>Format</tt>
166               <item><tt>Date</tt>
167               <item><tt>Source</tt>
168               <item><tt>Binary</tt>
169               <item><tt>Architecture</tt>
170               <item><tt>Version</tt>
171               <item><tt>Distribution</tt>
172               <item><tt>Urgency</tt>
173               <item><tt>Maintainer</tt>
174               <item><tt>Description</tt>
175               <item><tt>Changes</tt>
176               <item><tt>Files</tt>
177             </list>">
178
179 <!--
180      misc, non-debian
181   -->
182 <!entity pgp-keyserv "<tt>pgp5.ai.mit.edu</tt>">
183 <!entity file-keyservs "<file>/usr/share/doc/pgp/keyserv.doc</file>">
184
185 <!entity sample-dist-dirtree "<example>
186 dists/stable/main/
187 dists/stable/main/binary-i386/
188 dists/stable/main/binary-m68k/
189 dists/stable/main/binary-alpha/
190      ...
191 dists/stable/main/source/
192      ...
193 dists/stable/main/disks-i386/
194 dists/stable/main/disks-m68k/
195 dists/stable/main/disks-alpha/
196      ...
197
198 dists/stable/contrib/
199 dists/stable/contrib/binary-i386/
200 dists/stable/contrib/binary-m68k/
201 dists/stable/contrib/binary-alpha/
202      ...
203 dists/stable/contrib/source/
204
205 dists/stable/non-free/
206 dists/stable/non-free/binary-i386/
207 dists/stable/non-free/binary-m68k/
208 dists/stable/non-free/binary-alpha/
209      ...
210 dists/stable/non-free/source/
211
212 dists/testing/
213 dists/testing/main/
214      ...
215 dists/testing/contrib/
216      ...
217 dists/testing/non-free/
218      ...
219
220 dists/unstable
221 dists/unstable/main/
222      ...
223 dists/unstable/contrib/
224      ...
225 dists/unstable/non-free/
226      ...
227
228 pool/
229 pool/main/a/
230 pool/main/a/apt/
231      ...
232 pool/main/b/
233 pool/main/b/bash/
234      ...
235 pool/main/liba/
236 pool/main/liba/libalias-perl/
237      ...
238 pool/main/m/
239 pool/main/m/mailx/
240      ...
241 pool/non-free/n/
242 pool/non-free/n/netscape/
243      ...
244 </example>">
245
246 <!entity example-pathfind '<example>pathfind() {
247     OLDIFS="$IFS"
248     IFS=:
249     for p in $PATH; do
250         if [ -x "$p/$*" ]; then
251             IFS="$OLDIFS"
252             return 0
253         fi
254     done
255     IFS="$OLDIFS"
256     return 1
257 }</example>'>