source: trunk/README @ 587

Last change on this file since 587 was 587, checked in by landonf (Landon Fuller), 17 years ago

Better definition of sysportpath

  • Property svn:eol-style set to native
File size: 2.4 KB
Line 
1WHAT IS THE DARWIN PORTS SYSTEM
2
3    Darwin Ports 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    Darwin Ports 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 docs/INTERNALS.
12
13INSTALLING
14
15    Summary:
16        1. make
17        2. sudo make install
18        3. edit /etc/ports.conf
19
20    All necessary code and TCL will be compiled and installed as follows:
21        /System/Library/Tcl/8.3/darwinports1.0
22            - TCL library for interfacing with the Darwin Ports System
23        /opt/local/bin/portbuild
24            - Command line port building utility
25        /opt/local/share/darwinports/
26            - TCL libraries internal to the ports system
27        /etc/defaults/ports.conf
28            - System-wide port default settings
29
30    The /etc/ports.conf configuration file takes the same directives as
31a Portfile, and can be used to override all ports' defaults. There are optional
32and required directives that you should configure at install time.
33
34        sysportpath     - (required) Specifies the path to the software/
35                            directory. Used to find and build port
36                            dependencies
37        ports_debug     - (optional) Takes either a "yes" or "no" value.
38                            If set, debug messages are printed
39        ports_verbose   - (optional) Takes either a "yes" or "no" value.
40                            If set, informational messages are printed
41
42USING PORTBUILD
43
44    All included port descriptions are currently stored in the software/
45subdirectory of the ports distribution, in the form of:
46
47        software/<category>/<portname>
48
49    To build a port, cd to the port's directory and run 'portbuild'. To install
50a port, run 'portbuild install'. Please refer to the portbuild man page for
51complete documentation on the 'portbuild' command.
52
53CREATING NEW PORTS
54
55    Ports consist of directory containing both a Portfile and associated
56files. Currently the only bundled files are patch files, and these are likely
57to be kept to a minimum.
58
59    A Portfile consists of valid TCL, evaluated by a TCL interpreter
60instantiated by the Darwin Ports System. Portfiles use extremely straight-
61forward key/value pair syntax, while allowing the author to use the full
62extent of TCL's functionality where necessary.
63
64    To get started, refer to doc/exampleport.
Note: See TracBrowser for help on using the repository browser.