Document port restore and port migrate

This commit is contained in:
Joshua Root
2024-06-13 00:32:35 +10:00
parent 7cc56fe2ed
commit 68e284a958
5 changed files with 231 additions and 0 deletions
+2
View File
@@ -56,6 +56,7 @@ MAN1= \
port-log.1 \
port-logfile.1 \
port-mdmg.1 \
port-migrate.1 \
port-mirror.1 \
port-mpkg.1 \
port-notes.1 \
@@ -69,6 +70,7 @@ MAN1= \
port-rdeps.1 \
port-reclaim.1 \
port-reload.1 \
port-restore.1 \
port-rev-upgrade.1 \
port-search.1 \
port-select.1 \
+66
View File
@@ -0,0 +1,66 @@
'\" t
.TH "PORT\-MIGRATE" "1" "2\&.9\&.99" "MacPorts 2\&.9\&.99" "MacPorts Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
port-migrate \- Update MacPorts for a new platform\&.
.SH "SYNOPSIS"
.sp
.nf
\fBport\fR [\fB\-vdN\fR] \fBmigrate\fR
[\-\-all] [\-\-continue]
.fi
.SH "DESCRIPTION"
.sp
\fBport migrate\fR will reinstall the base MacPorts system and installed ports if they are not compatible with the current platform\&. It should be run after updating to a new major OS version, or after transferring a MacPorts installation to a computer with a different CPU architecture\&.
.SH "OPTIONS"
.PP
\fB\-\-all\fR
.RS 4
Migrate all ports including unrequested ones\&. By default, only requested ports and their dependencies are migrated\&.
.RE
.PP
\fB\-\-continue\fR
.RS 4
Continue with migration of ports\&. Normally only used internally when running the new copy of MacPorts base after it is rebuilt\&.
.RE
.SH "GLOBAL OPTIONS"
.sp
Please see the section \fBGLOBAL OPTIONS\fR in the \fBport\fR(1) man page for a description of global port options\&.
.PP
\fB\-N\fR
.RS 4
Non\-interactive mode, don\(cqt ask for confirmation before performing migration\&.
.RE
.SH "SEE ALSO"
.sp
\fBport\fR(1), \fBport-snapshot\fR(1), \fBport-restore\fR(1)
.SH "AUTHORS"
.sp
.if n \{\
.RS 4
.\}
.nf
(C) 2024 The MacPorts Project
Joshua Root <jmr@macports\&.org>
.fi
.if n \{\
.RE
.\}
+45
View File
@@ -0,0 +1,45 @@
// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
port-migrate(1)
===============
NAME
----
port-migrate - Update MacPorts for a new platform.
SYNOPSIS
--------
[cmdsynopsis]
*port* [*-vdN*] *migrate*
[--all] [--continue]
DESCRIPTION
-----------
*port migrate* will reinstall the base MacPorts system and installed ports
if they are not compatible with the current platform. It should be run
after updating to a new major OS version, or after transferring a MacPorts
installation to a computer with a different CPU architecture.
OPTIONS
-------
*--all*::
Migrate all ports including unrequested ones. By default, only requested
ports and their dependencies are migrated.
*--continue*::
Continue with migration of ports. Normally only used internally when running
the new copy of MacPorts base after it is rebuilt.
include::global-flags.txt[]
*-N*::
Non-interactive mode, don't ask for confirmation before performing migration.
SEE ALSO
--------
man:port[1], man:port-snapshot[1], man:port-restore[1]
AUTHORS
-------
(C) 2024 The MacPorts Project
Joshua Root <jmr@macports.org>
+71
View File
@@ -0,0 +1,71 @@
'\" t
.TH "PORT\-RESTORE" "1" "2\&.9\&.99" "MacPorts 2\&.9\&.99" "MacPorts Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
port-restore \- Restore snapshots of installed ports\&.
.SH "SYNOPSIS"
.sp
.nf
\fBport\fR [\fB\-vdN\fR] \fBrestore\fR
[\-\-snapshot\-id \fIid\fR] [\-\-last] [\-\-all]
.fi
.SH "DESCRIPTION"
.sp
\fBport restore\fR changes the set of active ports to match the state recorded in a previously created snapshot\&. All ports are first deactivated, and then each port included in the snapshot is installed or activated as needed, with the requested variants also as set in the snapshot\&.
.SH "OPTIONS"
.PP
\fB\-\-snapshot\-id ID\fR
.RS 4
Restore the snapshot with the specified ID\&.
.RE
.PP
\fB\-\-last\fR
.RS 4
Restore the last created snapshot\&.
.RE
.PP
\fB\-\-all\fR
.RS 4
Restore all ports in the snapshot including unrequested ones\&. By default, only requested ports and their dependencies are restored\&.
.RE
.SH "GLOBAL OPTIONS"
.sp
Please see the section \fBGLOBAL OPTIONS\fR in the \fBport\fR(1) man page for a description of global port options\&.
.PP
\fB\-N\fR
.RS 4
Non\-interactive mode, fail if multiple snapshots exist and a particular snapshot was not specified\&.
.RE
.SH "SEE ALSO"
.sp
\fBport\fR(1), \fBport-snapshot\fR(1), \fBport-migrate\fR(1)
.SH "AUTHORS"
.sp
.if n \{\
.RS 4
.\}
.nf
(C) 2024 The MacPorts Project
Joshua Root <jmr@macports\&.org>
.fi
.if n \{\
.RE
.\}
+47
View File
@@ -0,0 +1,47 @@
// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
port-restore(1)
===============
NAME
----
port-restore - Restore snapshots of installed ports.
SYNOPSIS
--------
[cmdsynopsis]
*port* [*-vdN*] *restore*
[--snapshot-id 'id'] [--last] [--all]
DESCRIPTION
-----------
*port restore* changes the set of active ports to match the state recorded
in a previously created snapshot. All ports are first deactivated, and then
each port included in the snapshot is installed or activated as needed,
with the requested variants also as set in the snapshot.
OPTIONS
-------
*--snapshot-id ID*::
Restore the snapshot with the specified ID.
*--last*::
Restore the last created snapshot.
*--all*::
Restore all ports in the snapshot including unrequested ones. By default,
only requested ports and their dependencies are restored.
include::global-flags.txt[]
*-N*::
Non-interactive mode, fail if multiple snapshots exist and a particular
snapshot was not specified.
SEE ALSO
--------
man:port[1], man:port-snapshot[1], man:port-migrate[1]
AUTHORS
-------
(C) 2024 The MacPorts Project
Joshua Root <jmr@macports.org>