README.md
1# portshaker
2
3## Description
4
5The `portshaker` utility maintains a set of *target* ports trees containing
6ports provided by *source* ports trees.
7
8A single *target* ports tree can contain ports from any number of *source*
9ports trees. If a port is provided by more than one *source* ports tree,
10`portshaker` will merge the latest version of this port in the *target* ports
11tree.
12
13As `portshaker` can maintain any number of *target* ports tree, it is
14particularly handy if you want to use customized ports trees with tinderbox /
15poudriere.
16
17## Using postshaker
18
19For install instructions, please refer to the INSTALL file. After installing,
20you will have to configure `portshaker(8)` since it is a toolkit and does nothing
21out of the box. Configuration instructions are provided in the distribution
22man pages: `portshaker(8)`, `portshaker.conf(5)` and `portshaker.d(5)`.
23
24IN ORDER TO PRODUCE REPRODUCTIBLE RESULTS, THE `PORTSHAKER(8)` PROGRAM'S FIRST
25ACTION WHEN MERGING PORTS IS TO RESET THE DESTINATION PORTS TREE. AS A
26CONSEQUENCE, IF YOU HAVE LOCAL EDITS IN YOUR TARGET PORTS TREE, THEY WILL BE
27LOST (AND SO DO ANY OTHER FILE IN THE DIRECTORY, E.G. VCS CONTROL FILES).
28
29
30Portions of sources of this tools code have been stolen from the following
31files from a FreeBSD 7.0-STABLE box:
32 - /etc/rc.subr
33 - /usr/share/man/man5/rc.conf.5.gz
34
35