source: trunk/README @ 1847

Last change on this file since 1847 was 1502, checked in by landonf (Landon Fuller), 18 years ago

Update README and README.fr to refer to new configuration settings in /etc/ports/ports.conf

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