[132712] trunk/base/doc

[cal at macports.org]

Revision: 132712
          https://trac.macports.org/changeset/132712
Author:   cal at macports.org
Date:     2015-02-08 09:43:17 -0800 (Sun, 08 Feb 2015)
Log Message:
-----------
base: generate roff from asciidoc, enable port-select.1, #44530, see NewHelpSystem

Modified Paths:
--------------
    trunk/base/doc/Makefile.in

Added Paths:
-----------
    trunk/base/doc/port-select.1

Modified: trunk/base/doc/Makefile.in
===================================================================
--- trunk/base/doc/Makefile.in	2015-02-08 17:42:24 UTC (rev 132711)
+++ trunk/base/doc/Makefile.in	2015-02-08 17:43:17 UTC (rev 132712)
@@ -70,6 +70,7 @@
 		port-reload.1 \
 		port-rev-upgrade.1 \
 		port-search.1 \
+		port-select.1 \
 		port-selfupdate.1 \
 		port-uninstall.1 \
 		port-unload.1 \

Added: trunk/base/doc/port-select.1
===================================================================
--- trunk/base/doc/port-select.1	                        (rev 0)
+++ trunk/base/doc/port-select.1	2015-02-08 17:43:17 UTC (rev 132712)
@@ -0,0 +1,109 @@
+'\" t
+.TH "PORT\-SELECT" "1" "2015\-02\-08" "MacPorts 2\&.3\&.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-select \- Switch between different implementations of a tool
+.SH "SYNOPSIS"
+.sp
+.nf
+\fBport\fR [\fB\-dvp\fR] \fBselect\fR \-\-summary
+.fi
+.sp
+.nf
+\fBport\fR [\fB\-dvp\fR] \fBselect\fR \-\-show \fIgroup\fR
+.fi
+.sp
+.nf
+\fBport\fR [\fB\-dvp\fR] \fBselect\fR [\-\-list] \fIgroup\fR
+.fi
+.sp
+.nf
+\fBport\fR [\fB\-dvp\fR] \fBselect\fR [\-\-set] \fIgroup\fR \fIoption\fR
+.fi
+.SH "DESCRIPTION"
+.sp
+\fBport select\fR provides a mechanism to choose from different implementations of a common tool or port\&. Selecting one of the options makes it the primary version or implementation, e\&.g\&. the one to be run by default when you do not explicitly select a version or implementation on the command line\&.
+.sp
+One example is the set of MySQL and forks of MySQL, where there are mysql51, mysql55, mysql56, mariadb, mariadb\-10\&.0, mariadb\-11\&.0, percona, possibly among others\&. \fBport select\fR lets you choose which of these becomes the version run, when you simply run \fImysql\fR or other commands from the MySQL suite\&.
+.sp
+\fBport select\fR has multiple modes of operation: It can display a summary, show the current primary implementation and list all available implementations given a group name, and change the primary implementation\&. See \fBOPTIONS\fR below for details\&.
+.SH "OPTIONS"
+.PP
+\fB\-\-summary\fR
+.RS 4
+Display a summary of all available selection groups, their current primary implementation and a list of all available choices\&.
+.RE
+.PP
+\fB\-\-show\fR \fIgroup\fR
+.RS 4
+Print the current primary implementation for the given group\&.
+.RE
+.PP
+\fB\-\-list\fR \fIgroup\fR
+.RS 4
+Print a list of all currently available choices for the given group\&. This is the default when
+\fBport select\fR
+is called with one argument\&.
+.RE
+.PP
+\fB\-\-set\fR \fIgroup\fR \fIoption\fR
+.RS 4
+Make
+\fIoption\fR
+the primary selection for the
+\fIgroup\fR
+group\&. This is the default when
+\fBport select\fR
+is called with two arguments\&.
+.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\&.
+.SH "EXAMPLES"
+.sp
+If you have both the mysql56 and the percona port installed, you can switch your implementation of the \fImysql\fR command by running
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+$> sudo port select \-\-set mysql $option
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+where \fI$option\fR is \fImysql56\fR if you want the version from MySQL, or \fIpercona\fR, if you want the version from Percona\&.
+.SH "SEE ALSO"
+.sp
+\fBport\fR(1)
+.SH "AUTHORS"
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+(C) 2015 The MacPorts Project
+Clemens Lang <cal at macports\&.org>
+.fi
+.if n \{\
+.RE
+.\}
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/macports-changes/attachments/20150208/bf85ea74/attachment-0001.html>