source: trunk/README @ 590

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

Change 'portbuild' to 'port' and explain required path changes

  • Property svn:eol-style set to native
File size: 2.8 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    Installation Steps:
16        1. make
17                Run 'make' within the darwinports directory to compile
18                all necessary software.
19
20        2. sudo make install
21                Run 'sudo make install' within the darwinports directory
22                to install darwinports on your system.
23
24        3. edit /etc/ports.conf
25                The /etc/ports.conf configuration file takes the same
26                directives as a Portfile, and can be used to override all
27                ports' defaults. There are required and optional directives
28                that you should configure at install time.
29
30                sysportpath - (required) Specifies the path to the software
31                            directory. Used to find and build port
32                            dependencies
33
34                ports_debug - (optional) Takes either a "yes" or "no" value.
35                            If set, debug messages are printed
36
37                ports_verbose - (optional) Takes either a "yes" or "no" value.
38                            If set, informational messages are printed
39
40    All necessary code and TCL will be compiled and installed as follows:
41        /System/Library/Tcl/8.3/darwinports1.0
42            - TCL library for interfacing with the Darwin Ports System
43        /opt/local/bin/port
44            - Command line port building utility
45        /opt/local/share/darwinports/
46            - TCL libraries internal to the ports system
47        /etc/defaults/ports.conf
48            - System-wide port default settings
49
50
51USING THE PORT COMMAND
52
53    If you haven't already, add /opt/local/bin to your path. If you're
54unsure how, add the following line to your ~/.cshrc file.
55
56        set path=($path /opt/local/bin)
57
58    Your changes to ~/.cshrc will not take effect until you have opened
59a new shell.
60
61    All included port descriptions are currently stored in the software/
62subdirectory of the ports distribution, in the form of:
63
64        software/<category>/<portname>
65
66    To build a port, cd to the port's directory and run 'port'. To install
67a port, run 'port install'. Please refer to the port man page for
68complete documentation on the port command.
69
70CREATING NEW PORTS
71
72    Ports consist of directory containing both a Portfile and associated
73files. Currently the only bundled files are patch files, and these are likely
74to be kept to a minimum.
75
76    A Portfile consists of valid TCL, evaluated by a TCL interpreter
77instantiated by the Darwin Ports System. Portfiles use extremely straight-
78forward key/value pair syntax, while allowing the author to use the full
79extent of TCL's functionality where necessary.
80
81    To get started, refer to doc/exampleport.
Note: See TracBrowser for help on using the repository browser.