source: trunk/README @ 8099

Last change on this file since 8099 was 7715, checked in by wbb4, 16 years ago

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

Reversed the ordering of Jaguar -vs- Panter isms, and did some general whitespace cleanup.

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