[darwinbuild-changes] [810] branches/PR-6973110/darwinup/darwinup.1

Fri Apr 16 11:04:54 PDT 2010

Revision: 810
          http://trac.macosforge.org/projects/darwinbuild/changeset/810
Author:   wsiegrist at apple.com
Date:     2010-04-16 11:04:52 -0700 (Fri, 16 Apr 2010)
Log Message:
-----------
The rest of the man page.

Modified Paths:
--------------
    branches/PR-6973110/darwinup/darwinup.1

Modified: branches/PR-6973110/darwinup/darwinup.1
===================================================================

--- branches/PR-6973110/darwinup/darwinup.1	2010-04-15 22:52:22 UTC (rev 809)
+++ branches/PR-6973110/darwinup/darwinup.1	2010-04-16 18:04:52 UTC (rev 810)
@@ -24,7 +24,7 @@
 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 @APPLE_BSD_LICENSE_HEADER_END@
 ..
-.Dd 6 Apr, 2010
+.Dd 16 Apr, 2010
 .Dt darwinup 1
 .Os Darwin
 .Sh NAME
@@ -129,6 +129,104 @@
 the file was restored. 
 .El
 .Sh SUPPORTED PATHS
+.Bl -tag -width -indent
+.It /path/to/local/file-or-directory
+You can install files from one of your locally mounted filesystems. The path
+can be a directory, in which case all files below it will be installed, or
+it can be a archive file. The supported file formats are listed in the usage
+statement, but typical formats are .tgz, .tbz2, or .zip.
+.It user at host:/path/to/remote/file-or-directory
+You can install files from a remote machine via rsync/ssh. The remote files
+will be copied to your local depot and then installed like any other local
+root.
+.It http[s]://host/path/to/remote/file
+You can install files from an archive hosted on an HTTP/HTTPS server. The
+archive file will be downloaded using curl to your local depot and then
+installed like any other local archive. You can not point darwinup at a
+directory hosted via HTTP or HTTPS, only archive files such as tarballs.  
+.El
 .Sh ARCHIVE SPECIFICATIONS
+When running a subcommand which takes an 
+.Ar archive
+argument, you can use one or more of the following items to specify which
+archive to operate on. You can mix and match any of them as needed. 
+You can use the list subcommand with these specifications to see what will 
+match.
+.Bl -tag -width -indent
+.It Ar serial
+You can specify an archive with its serial number, which can be found using
+the list subcommand.
+.It Ar uuid
+You can specify an archive with its UUID, which can be found using the
+list subcommand.
+.It Ar name
+You can specify an archive with its name, which can be found using the
+list subcommand.
+.It newest
+The newest keyword will match the one archive which was most recently
+installed. This should always be the first archive listed.
+.It oldest
+The oldest keyword will match the one archive which was installed the
+longest time ago. This should always be the last archive listed. 
+.It superseded
+The superseded keyword will match zero or more archives. An archive is
+superseded if every file it contains is contained in an archive that was
+(and still is) installed after it. A file in an archive can also be superseded
+by external changes, such as operating system updates. When uninstalling a
+superseded archive, you should never see any status symbols, since being
+superseded means there is a newer file on disk. 
+.It all
+The all keyword will match all archives. If you specify extra verbosity 
+with -vv, then rollback archives will also be matched by the all keyword. This
+means that 
+.Nm darwinup -vv uninstall all
+will attempt to uninstall rollback archives, which will print a message
+about not being able to uninstall rollback archives. This is normal and
+not a problem. 
+.El
 .Sh FORCING OPERATIONS
+There are 2 cases where darwinup will require you to pass the force (-f)
+option before proceeding with an operation.
+.Bl -tag -width -indent
+.It Object Type Change
+If you install an archive which contains a file with the same path as a 
+directory on your system, or vice versa, darwinup will give you a error
+about not doing that unless you really want to force it. If you do force
+the operation, darwinup will delete the existing object and replace it with
+the object from the root. This can happen when a directory full of files
+gets packaged up in some opaque file, like xibs/nibs. If you expect this
+"type change", then it is probably safe to force the operation. 
+.It Uninstall a root from an older base system
+Darwinup remembers the version (build) of the operating system when a root
+is installed. The reason for this is darwinup saves the old (replaced)
+files during the installation procedure. Those backups may have come from
+the older operating system, and thus are not necessarily compatible with
+the current build of the operating system. So if you try to uninstall an
+archive that had been installed on a different version of the operating
+system, darwinup will stop and provide a message asking you to force the
+operation if you really want to. If the files you are uninstalling are all
+superseded, then you should not get this error as the backup copies will
+not be used anyway. 
+.El
 .Sh EXAMPLES
+.Bl -tag -width -indent
+.It Install files from a tarball
+$ darwinup install library-1.2.3.tar.gz
+.It Install several directories from /tmp/
+$ darwinup install /tmp/*/*~dst/
+.It Uninstall everything
+$ darwinup uninstall all
+.It See what archives have been superseded and then uninstall them
+$ darwinup list superseded
+$ darwinup uninstall superseded
+.It Uninstall several archives by serial, the oldest one, and one named myroot
+$ darwinup uninstall 9 16 myroot oldest
+.It Install a root from src.macosforge.org
+$ darwinup install http://src.macosforge.org/Roots/10D573/zlib.root.tar.gz
+.El
+.Sh SEE ALSO
+.Xr rsync 1 ,
+.Xr curl 1 ,
+.Xr tar 1 ,
+.Xr gzip 1 ,
+.Xr ditto 1
\ No newline at end of file
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/darwinbuild-changes/attachments/20100416/99d274b0/attachment.html>
