source: trunk/README @ 3895

Last change on this file since 3895 was 3895, checked in by fkr, 16 years ago

Bug:
Submitted by:
Reviewed by:
Approved by:
Obtained from:

updated to mention 10.3

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