Annotation of pkgsrc/pkgtools/pkg_rolling-replace/files/pkg_rolling-replace.8, revision 1.18
1.18 ! wiz 1: .\" $NetBSD: pkg_rolling-replace.8,v 1.17 2010/02/01 09:33:21 sno Exp $
1.17 sno 2: .Dd February 1, 2010
1.1 gdt 3: .Dt PKG_ROLLING-REPLACE 8
1.2 wiz 4: .Os
1.1 gdt 5: .Sh NAME
6: .Nm pkg_rolling-replace
7: .Nd rebuild or update packages using 'make replace' in tsorted order
8: .Sh SYNOPSIS
9: .Nm
1.18 ! wiz 10: .Op Fl Fhknrsuv
1.17 sno 11: .Op Fl D Ar bool
12: .Op Fl j Ar jobs
1.15 sno 13: .Op Fl L Ar path
1.14 wiz 14: .Op Fl X Ar pkgs
1.1 gdt 15: .Op Fl x Ar pkgs
16: .Sh DESCRIPTION
17: .Nm
1.2 wiz 18: runs
19: .Dq make replace
1.7 tnn 20: on packages that have been marked to have unsafe dependencies or have
21: been marked to be rebuilt.
22: Optionally it can replace any outdated packages (as reported by
1.1 gdt 23: .Xr pkg_chk 8 )
24: as well.
25: .Pp
1.2 wiz 26: Whenever
27: .Dq make replace
28: is run on a package, all installed packages
29: that depend on it are marked with the
1.7 tnn 30: .Dq unsafe_depends_strict=YES
1.8 wiz 31: flag.
32: If the version of the replaced package has changed, this indicates
1.7 tnn 33: that it may no longer be ABI-compatible so
1.2 wiz 34: .Dq unsafe_depends=YES
1.7 tnn 35: is also set for all packages that depend on it.
1.2 wiz 36: Running
1.1 gdt 37: .Nm
38: with no arguments will restore such packages to a safe state by
39: building a dependency graph, running
40: .Xr tsort 1
1.2 wiz 41: on it, and running
42: .Dq make replace
43: in the resulting topological order.
1.1 gdt 44: The dependency graph and topological sort are re-calculated after each
1.2 wiz 45: .Dq make replace ,
46: in case it causes additional packages to be marked unsafe.
1.1 gdt 47: .Pp
48: The user can mark additional packages to be rebuilt by setting the
1.2 wiz 49: .Dq rebuild=YES
50: flag on them using the command
51: .Dl % pkg_admin set rebuild=YES Aq pkg
1.1 gdt 52: .Pp
53: If the
54: .Fl u
55: option is given,
56: .Nm
57: will use
1.12 tnn 58: .Xr pkg_chk 8
1.1 gdt 59: to check for packages for which the version in pkgsrc is different
1.2 wiz 60: than the installed version, and run
61: .Dq make replace
62: on those packages as well (tsorting them along with the unsafe/rebuild
63: packages).
1.1 gdt 64: (Usually this results in packages being upgraded to newer versions,
65: assuming the pkgsrc tree is more recent than the currently installed
66: packages.)
67: .Ss Options
68: .Bl -tag -width xxxxxxxx
1.18 ! wiz 69: .It Fl D Ar bool
! 70: Sets
! 71: .Dq USE_DESTDIR
! 72: to the given boolean value
! 73: .Ar bool
! 74: .Po Dv YES No or Dv NO Pc .
! 75: The default value is
! 76: .Dq NO
! 77: to ensure the same behaviour for pkgsrc developers when the act as users
! 78: and update their system.
! 79: To disable the default behaviour and fall back to pkgsrc defaults, use
! 80: .Dq OFF
! 81: as
! 82: .Ar bool
! 83: parameter.
1.15 sno 84: .It Fl F
85: Just fetches the sources of all mismatched packages required to be updated
86: (and it's dependencies).
1.18 ! wiz 87: .It Fl h
! 88: Brief help.
1.15 sno 89: .It Fl k
90: Keep on going, even on error during handling current package.
91: Warning: This could (potential will) rebuild package depending
1.18 ! wiz 92: on the failed package, anyway.
! 93: This may cause a broken tree.
1.15 sno 94: Use with caution!
1.17 sno 95: .It Fl j Ar jobs
1.18 ! wiz 96: Enables a pkgsrc tunable
! 97: .Pq Dv MAKE_JOBS= Ns Aq n
! 98: to allow parallel build while
! 99: compiling a package.
! 100: It's unset by default.
! 101: .It Fl L Ar path
! 102: Logs each build (each command output from the commands which are run for
! 103: packages) to given path.
! 104: The full log file name is composed from the path given by this
! 105: argument, the category name of the package and the package name:
! 106: .Dq given-path/category/pkgname .
! 107: The specified path must exists and being user writable of the invoking
! 108: user or any parent directory must be writable by the invoking user.
! 109: Potentially existing log in the same file name will be overwritten.
1.1 gdt 110: .It Fl n
1.2 wiz 111: Display actions that would be taken, but don't actually run
112: .Dq make replace
113: or change any flags on installed packages.
114: This option attempts to calculate the new packages that would be
115: marked unsafe after each
116: .Dq make replace .
1.7 tnn 117: .It Fl r
118: Just replace packages, do not build binary packages.
119: .It Fl s
1.8 wiz 120: Enable strict mode.
121: This makes
1.7 tnn 122: .Nm
1.8 wiz 123: look at
1.7 tnn 124: .Dq unsafe_depends_strict
125: tags instead of
126: .Dq unsafe_depends
1.8 wiz 127: tags.
128: This will replace packages more aggressively and can be used to solve
1.7 tnn 129: shared library problems.
1.1 gdt 130: .It Fl u
131: Use
132: .Xl pkg_chk 8
133: to check for outdated packages, and replace those too.
134: .It Fl v
135: Verbose output.
1.14 wiz 136: .It Fl X Ar pkgs
137: Exclude the comma-separated list of package base names
138: from being rebuilt for any reason.
1.1 gdt 139: .It Fl x Ar pkgs
1.9 apb 140: Exclude the comma-separated list of package base names
141: from the check for outdated packages.
142: This has no effect if the
1.1 gdt 143: .Fl u
1.9 apb 144: flag is not given,
145: and does not prevent packages from being rebuilt for any other reason
146: (such as being a dependency of another package that is also rebuilt,
147: or having any of the
1.14 wiz 148: .Xr pkg_admin 1
1.9 apb 149: .Dq unsafe_depends ,
150: .Dq unsafe_depends_strict ,
151: or
152: .Dq rebuild
153: variables set to
154: .Dq YES ) .
1.1 gdt 155: .El
156: .Sh ENVIRONMENT
157: .Nm
158: uses the following environment variables.
159: .Bl -tag -width xxxx
1.3 tnn 160: .It Ev MAKECONF
161: Path to
162: .Pa mk.conf .
163: Defaults to
1.11 apb 164: .Pa @MAKECONF@ , @PREFIX@/etc/mk.conf ,
1.5 tnn 165: or
1.11 apb 166: .Pa /etc/mk.conf .
1.1 gdt 167: .It Ev PKGSRCDIR
1.2 wiz 168: Base of pkgsrc tree.
1.11 apb 169: If not set in the environment, then this variable is read from
170: .Pa ${MAKECONF} .
171: If it is still not set, and if the current working directory
172: appears to be inside a pkgsrc tree, then this variable
173: is set to the base of that pkgsrc tree.
174: Finally, if
1.3 tnn 175: .Pa /usr/pkgsrc
1.11 apb 176: appears to contain a pkgsrc tree, then that is used as a last resort.
1.1 gdt 177: .It Ev PKG_DBDIR
178: pkgsrc database directory.
179: If not set in environment then defaults to
1.2 wiz 180: .Pa /var/db/pkg .
1.1 gdt 181: .El
1.14 wiz 182: .Sh EXAMPLES
183: To update all packages on the system and ensure correct shared library
184: dependencies:
185: .Bd -literal -offset indent
186: pkg_rolling-replace -rsuv
187: .Ed
188: .Pp
189: To update all packages on the system, do as little rebuilding as possible,
190: and also produce binary packages:
191: .Bd -literal -offset indent
192: pkg_rolling-replace -uv
193: .Ed
194: .Pp
1.15 sno 195: To fetch all distfiles for the packages requiring an update on the system
196: (packages with different version numbers than installed), and exit after it:
197: .Bd -literal -offset indent
198: pkg_rolling-replace -F
199: .Ed
200: .Pp
1.14 wiz 201: To update gtk2+ and all packages that depend on it, except openoffice2:
202: .Bd -literal -offset indent
203: pkg_admin set rebuild=YES gtk2+
204: pkg_rolling-replace -rsv -X openoffice2
205: .Ed
206: .Pp
1.15 sno 207: To force rebuild of gtk2+ and all packages that depend on it, keep
208: going on even if one package fails, except openoffice2 - log to
209: .Dq /var/log/pkg_rr :
210: .Bd -literal -offset indent
211: pkg_admin set rebuild=YES gtk2+
212: pkg_rolling-replace -krsv -L /var/log/pkg_rr -X openoffice2
213: .Ed
214: .Pp
1.14 wiz 215: To mark all packages that compiled against X11 as needing rebuild
216: (used after switching to X11_TYPE=modular):
217: .Bd -literal -offset indent
218: cd /var/db/pkg \*[Am]\*[Am] grep "blddep x11-links" */* | cut -d/ -f1 | \\
219: sort -u | xargs pkg_admin set rebuild=YES
220: .Ed
1.1 gdt 221: .Sh AUTHORS
1.2 wiz 222: .An -nosplit
1.1 gdt 223: .An Nick Goffee
224: .Aq ngoffee@bbn.com ,
225: with initial idea and many suggestions from
226: .An Greg Troxel
227: .Aq gdt@ir.bbn.com .
1.8 wiz 228: The options
229: .Fl s
230: and
231: .Fl r
232: were added by
1.7 tnn 233: .An Tobias Nygren
234: .Aq tnn@NetBSD.org .
1.15 sno 235: The options
236: .Fl k ,
1.17 sno 237: .Fl j ,
238: .Fl D ,
1.15 sno 239: .Fl F
240: and
241: .Fl L
242: were added by
243: .An Jens Rehsack
244: .Aq sno@NetBSD.org .
1.1 gdt 245: .Sh BUGS
246: .Nm
247: does not run fully automatically when any significant number of
248: packages need to be replaced.
1.15 sno 249: .Pp
250: .Nm
251: does not run fully automatically when the PKGNAME of a package
252: changes.
CVSweb <webmaster@jp.NetBSD.org>