source: trunk/README @ 738

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

Bring documentation closer to reality

  • Property svn:eol-style set to native
File size: 3.2 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/ports.conf
25                The /etc/ports/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                portdbpath - (options) Specifies path to store ports system
31                            specific data.
32
33                ports_debug - (optional) Takes either a "yes" or "no" value.
34                            If set, debug messages are printed
35
36                ports_verbose - (optional) Takes either a "yes" or "no" value.
37                            If set, informational messages are printed
38
39        3. edit /etc/ports/sources.conf
40                The /etc/ports/sources.conf file lists the location of
41                both local and remote port software hierarchies. By default,
42                the ports system will fetch ports from www.opendarwin.org.
43                If you wish to use a local ports tree, specify it here.
44
45    All necessary code and TCL will be compiled and installed as follows:
46        /System/Library/Tcl/8.3/darwinports1.0
47            - TCL library for interfacing with the Darwin Ports System
48        /opt/local/bin/port
49            - Command line port building utility
50        /opt/local/share/darwinports/
51            - TCL libraries internal to the ports system
52        /etc/defaults/ports.conf
53            - System-wide port default settings
54        /etc/ports/ports.conf
55            - User customizable port settings
56        /etc/ports/sources.conf
57            - List of port sources
58
59
60USING THE PORT COMMAND
61
62    If you haven't already, add /opt/local/bin to your path. If you're
63unsure how, add the following line to your ~/.cshrc file.
64
65        set path=($path /opt/local/bin)
66
67    Your changes to ~/.cshrc will not take effect until you have opened
68a new shell.
69
70    To update your local indexes, run:
71
72        port sync
73
74    The following command will build and install a port:
75
76        port install <portname>
77
78    To find a specific port, try using "port search".
79
80        port search vi
81
82    Please refer to the port man page for complete documentation on the port
83    command.
84
85CREATING NEW PORTS
86
87    Ports consist of directory containing both a Portfile and associated
88files. Currently the only bundled files are patch files, and these are likely
89to be kept to a minimum.
90
91    A Portfile consists of valid TCL, evaluated by a TCL interpreter
92instantiated by the Darwin Ports System. Portfiles use extremely straight-
93forward key/value pair syntax, while allowing the author to use the full
94extent of TCL's functionality where necessary.
95
96    To get started, refer to doc/exampleport and the portfile(7) man page.
Note: See TracBrowser for help on using the repository browser.