source: trunk/README @ 3886

Last change on this file since 3886 was 3886, checked in by fkr, 16 years ago

Bug:
Submitted by: wbb4@
Reviewed by:
Approved by:
Obtained from:

mention different shells

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