source: trunk/README @ 3336

Last change on this file since 3336 was 3336, checked in by ssen, 17 years ago

Update paths. Removed stale info about FreeBSD configuration. Updated
how to change PREFIX using --prefix

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