CRUX-ARM : Home

Home :: Documentation :: Download :: Development :: Community :: Ports :: Packages :: Bugs :: Links :: About :: Donors
- Added pkginfo to .gitignore
[pkgutils-cross.git] / rejmerge.8.in
CommitLineData
9ac667e6
SR
1.TH rejmerge 8 "" "pkgutils #VERSION#" ""
2.SH NAME
3rejmerge \- merge files that were rejected during package upgrades
4.SH SYNOPSIS
5\fBrejmerge [options]\fP
6.SH DESCRIPTION
7\fBrejmerge\fP is a \fIpackage management\fP utility that helps you merge files that were rejected
8during package upgrades. For each rejected file found in \fI/var/lib/pkg/rejected/\fP, \fBrejmerge\fP
9will display the difference between the installed version and the rejected version. The user can then
10choose to keep the installed version, upgrade to the rejected version or perform a merge of the two.
11
12.SH OPTIONS
13.TP
14.B "\-r, \-\-root <path>"
15Specify alternative root (default is "/"). This should be used
16if you want to merge rejected files on a temporary mounted partition,
17which is "owned" by another system.
18.TP
19.B "\-v, \-\-version"
20Print version and exit.
21.TP
22.B "\-h, \-\-help"
23Print help and exit.
24.SH CONFIGURATION
25When \fBrejmerge\fP is started it will source \fI/etc/rejmerge.conf\fP.
26This file can be used to alter the way \fBrejmerge\fP displays file differences and performs file
27merges. Changing the default behaviour is done by re-defining the shell functions \fBrejmerge_diff()\fP
28and/or \fBrejmerge_merge()\fP.
29.TP
30.B rejmerge_diff()
31This function is executed once for each rejected file. Arguments \fB$1\fP and \fB$2\fP contain the paths
32to the installed and rejected files. Argument \fB$3\fP contains the path to a temporary file where this
33function should write its result. The contents of the temporary file will later be presented to the user
34as the difference between the two files.
35.TP
36.B rejmerge_merge()
37This function is executed when the user chooses to merge two files. Arguments \fB$1\fP and \fB$2\fP
38contain the paths to the installed and rejected files. Argument \fB$3\fP contains the path to a temporary
39file where this function should write its result. The contents of the temporary file will later be
40presented to the user as the merge result.
41This function also has the option to set the variable \fB$REJMERGE_MERGE_INFO\fP. The contents of this
42variable will be displayed as informational text after a merge has been performed. Its purpose is to provide
43information about the merge, e.g. "5 merge conflicts found".
44
45.PP
46Example:
47
48.nf
49#
50# /etc/rejmerge.conf: rejmerge(8) configuration
51#
52
53rejmerge_diff() {
54 # Use diff(1) to produce side-by-side output
55 diff -y $1 $2 > $3
56}
57
58rejmerge_merge() {
59 # Use sdiff(1) to merge
60 sdiff -o $3 $1 $2
61}
62
63# End of file
64.fi
65
66.SH FILES
67.TP
68.B "/etc/rejmerge.conf"
69Configuration file.
70.TP
71.B "/var/lib/pkg/rejected/"
72Directory where rejected files are stored.
73.SH SEE ALSO
74pkgadd(8), pkgrm(8), pkginfo(8), pkgmk(8)
75.SH COPYRIGHT
d804a38f 76rejmerge (pkgutils) is Copyright (c) 2000-2005 Per Liden and Copyright (c) 2006-2013 CRUX team (http://crux.nu).
6fe55c25
TS
77rejmerge (pkgutils) is licensed through the GNU General Public License.
78Read the COPYING file for the complete license.