source: trunk/README @ 12449

Last change on this file since 12449 was 12092, checked in by jmpp, 15 years ago

Submitted by: jmpp@

Small change in documentation URL to give more relevance to the DP site.
I'm thinking, however, about the relevance of these files now that we are
distributing a 1.0 tarball that doesn't include them...

  • Property svn:eol-style set to native
File size: 4.8 KB
Line 
1WHAT IS THE DARWIN PORTS SYSTEM
2
3    DarwinPorts is a software build, install, and packaging infrastructure
4designed to meet the same functionality requirements as the FreeBSD ports
5architecture while maintaining extensibility for future enhancement.
6
7    DarwinPorts currently builds and runs on MacOS X 10.2 (Darwin 6.0) and
8MacOS X 10.3 (Darwin 7.0).  The system is portable, written in TCL with a
9limited set of TCL extensions in C.
10
11    The "DarwinPorts User Guide" is available at:
12        http://darwinports.opendarwin.org/docs
13
14    For in-depth documentation on the internals of the ports system
15architecture, refer to base/doc/INTERNALS.
16
17    Please note that DarwinPorts is split into two parts.  The "darwin ports
18infrastructure", which lives in the base/ subdirectory and is the only
19mandatory component of the system, and the "dports" directory which contains
20the actual ported software descriptions.  The latter is optional and can be
21either fetched on demand over the net or a local copy can be used.  See
22documentation on ${prefix}/etc/ports/sources.conf below.
23
24INSTALLATION
25
26        For platform specific instructions, read base/doc/README.platforms.
27
28    Installation Steps:
29
30        1. cd base/
31           ./configure
32                Switch to the base/ directory and run the configure-script.
33                Optionally parameters can be passed to the configure-script
34                (see below).
35   
36        2. make
37                Run 'make' to compile all necessary software.
38               
39        3. sudo make install
40                Run 'sudo make install' to install DarwinPorts on your system.
41
42        4. [optional] edit ${prefix}/etc/ports/ports.conf
43                The ${prefix}/etc/ports/ports.conf configuration file defines several
44                configuration options for the DarwinPorts infrastructure. If
45                you wish to change installation paths or the location at
46                which various port system specific data is stored, change the
47                following settings:
48
49                portdbpath      Specifies path to store ports system specific
50                                data.
51                prefix          Specifies directory in which to install ports.
52
53        5. [optional] edit ${prefix}/etc/ports/sources.conf
54                The ${prefix}/etc/ports/sources.conf file lists the location of both
55                local and remote port software hierarchies. If the
56                --with-dports-dir=DIR argument was not specified for the
57                ./configure script, the default dports-tree
58                (darwinports/dports, the copy from which you install) will be
59                added to sources.conf.
60
61    All necessary code and TCL will be compiled and installed as follows:
62        [Mac OS X 10.3] /Library/Tcl/darwinports1.0
63        [Mac OS X 10.2] /System/Library/Tcl/darwinports1.0
64        [FreeBSD] /usr/local/lib/tcl8.3/darwinports1.0
65            - TCL library for interfacing with the DarwinPorts System
66
67        ${prefix} is set to /opt/local but can be overridden by changing
68        directory to the base/ directory and running ./configure
69        manually with a --prefix argument
70
71        ${prefix}/bin/port
72            - Command line port building utility
73        ${prefix}/share/darwinports/
74            - TCL libraries internal to the ports system
75
76        The following files are provided for customization of the system:
77
78        ${prefix}/etc/ports/ports.conf
79            - User customizable port settings
80        ${prefix}/etc/ports/sources.conf
81            - List of port sources (places to get ports data from)
82
83
84USING THE PORT COMMAND
85
86    If you haven't already, add /opt/local/bin to your path (or ${prefix}/bin
87if you've elected to install DarwinPorts somewhere else).
88
89        If you're unsure how and using Panther (OS X 10.3), add the following
90line to your ~/.profile file.  If this file does not exist, create it. (This
91also applies if you're using a bourne shell in Jaguar.)
92       
93        export PATH=$PATH:/opt/local/bin
94
95        If using Jaguar (OS X 10.2), add the following line to your ~/.cshrc file.
96If this file does not exist, create it. (This also applies if you're using tcsh in Panther.)
97
98        set path=($path /opt/local/bin)
99       
100    Your changes will not take effect until you have opened a new shell.
101
102    The following command will build and install a port:
103
104        port install <portname>
105
106    To find a specific port, try using "port search".
107
108        port search vi
109
110    Please refer to the port(1) man page for complete documentation on the port
111    command.
112
113    It is also possible to do operations, like building or fetching, for
114    all ports on the system using the portall command.  It takes essentially
115    the same arguments as the port command but operates iteratively on every
116    port in dports/.
117
118
119CREATING NEW PORTS
120
121    Ports consist of directory containing both a Portfile and associated
122files. Currently the only bundled files are patch files, and these are likely
123to be kept to a minimum.
124
125    A Portfile consists of valid TCL, evaluated by a TCL interpreter
126instantiated by the DarwinPorts System. Portfiles use extremely straight-
127forward key/value pair syntax, while allowing the author to use the full
128extent of TCL's functionality where necessary.
129
130    To get started, refer to base/doc/exampleport and the portfile(7) man page,
131or The DarwinPorts Guide, at http://darwinports.opendarwin.org/docs .
Note: See TracBrowser for help on using the repository browser.