summaryrefslogtreecommitdiff
path: root/doc/guide/files/pkgsrc.xml
blob: 3a06b7388136723308ca07728ffc4cc5ff86b844 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
<?xml version="1.0"?>
<!-- $NetBSD: pkgsrc.xml,v 1.25 2007/08/15 06:32:38 rillig Exp $ -->

<!DOCTYPE book PUBLIC "-//NetBSD//DTD DocBook XML V4.2-Based DocBook Extension//EN" [

<!ENTITY % man-refs.ent PUBLIC "-//NetBSD//ENTITIES NetBSD Manual Page Entities//EN">
%man-refs.ent;
<!ENTITY % misc.ent PUBLIC "-//NetBSD//ENTITIES NetBSD Miscellaneous Entities//EN">
%misc.ent;
<!ENTITY % chapters SYSTEM "chapters.ent">
%chapters;
<!ENTITY % entities SYSTEM "pkgsrc.ent">
%entities;
]>

<book id="the-pkgsrc-guide">
  <bookinfo>
    <title>The pkgsrc guide</title>
    <subtitle>Documentation on the NetBSD packages system</subtitle>

    <authorgroup>
      <author>
	<firstname>Alistair</firstname>
	<surname>Crooks</surname>

	<affiliation>
	  <address><email>agc@NetBSD.org</email></address>
	</affiliation>
      </author>

      <author>
	<firstname>Hubert</firstname>
	<surname>Feyrer</surname>

	<affiliation>
	  <address><email>hubertf@NetBSD.org</email></address>
	</affiliation>
      </author>
      <corpauthor>
        The pkgsrc Developers
      </corpauthor>
    </authorgroup>

    <copyright>
      <year>1994-2007</year>

      <holder role="mailto:www@NetBSD.org">The NetBSD Foundation, Inc</holder>
    </copyright>

    <pubdate>$NetBSD: pkgsrc.xml,v 1.25 2007/08/15 06:32:38 rillig Exp $</pubdate>

    <abstract>

	<para>pkgsrc is a centralized package management system for
	Unix-like operating systems. This guide provides information for
	users and developers of pkgsrc. It covers installation of binary
	and source packages, creation of binary and source packages and
	a high-level overview about the infrastructure.</para>

    </abstract>
  </bookinfo>

  &chap.intro;

  <part id="users-guide"> <?dbhtml filename="users-guide.html"?>
    <title id="users-guide.title">The pkgsrc user's guide</title>

    &chap.getting;
    &chap.platform;
    &chap.using;
    &chap.configuring;
    &chap.binary;
    &chap.files;
    &chap.faq;
  </part>

  <!-- "part II" (we need to rid the documentation of this reference) -->
  <part id="developers-guide"> <?dbhtml filename="developers-guide.html"?>
    <title id="developers-guide.title">The pkgsrc developer's guide</title>

	<partintro><para>This part of the book deals with creating and
	modifying packages. It starts with a <quote>HOWTO</quote>-like
	guide on creating a new package. The remaining chapters are more
	like a reference manual for pkgsrc.</para></partintro>

    &chap.creating;
    &chap.components;
    &chap.makefile;
    &chap.plist;
    &chap.buildlink;
    &chap.pkginstall;
    &chap.options;
    &chap.build;
    &chap.tools;
    &chap.fixes;
    &chap.debug;
    &chap.submit;
    &chap.devfaq;
    &chap.gnome;
  </part>

  <!-- The pkgsrc infrastructure -->
  <part id="infrastructure"><?dbhtml filename="infrastructure.html"?>
    <title id="infrastructure.title">The pkgsrc infrastructure internals</title>

	<partintro><para>This part of the guide deals with everything
	from the infrastructure that is behind the interfaces described
	in the developer's guide. A casual package maintainer should not
	need anything from this part.</para></partintro>

    &chap.infr.design;
    &chap.regression;
    &chap.porting;
  </part>

  <!-- appendix -->
  &chap.examples;
  &chap.logs;
  &chap.ftp-layout;
  &chap.editing;
</book>