[123020] trunk/base/doc

[cal at macports.org]

Revision: 123020
          https://trac.macports.org/changeset/123020
Author:   cal at macports.org
Date:     2014-08-03 14:09:18 -0700 (Sun, 03 Aug 2014)
Log Message:
-----------
base: document port help, move links to further documentation into separate file for re-usability

Modified Paths:
--------------
    trunk/base/doc/Makefile.in
    trunk/base/doc/portundocumented.7.txt

Added Paths:
-----------
    trunk/base/doc/furtherdocs.txt
    trunk/base/doc/port-help.1.txt

Modified: trunk/base/doc/Makefile.in
===================================================================
--- trunk/base/doc/Makefile.in	2014-08-03 21:04:11 UTC (rev 123019)
+++ trunk/base/doc/Makefile.in	2014-08-03 21:09:18 UTC (rev 123020)
@@ -26,6 +26,7 @@
 		port-edit.1 \
 		port-extract.1 \
 		port-fetch.1 \
+		port-help.1 \
 		port-install.1 \
 		port-patch.1 \
 		port-rev-upgrade.1 \

Added: trunk/base/doc/furtherdocs.txt
===================================================================
--- trunk/base/doc/furtherdocs.txt	                        (rev 0)
+++ trunk/base/doc/furtherdocs.txt	2014-08-03 21:09:18 UTC (rev 123020)
@@ -0,0 +1,15 @@
+// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
+Further documentation on MacPorts can be found in the following places:
+
+guide:[The MacPorts Guide]::
+    Detailed help and support guide
+wiki:[The MacPorts Wiki]::
+    MacPorts usage, development, and support
+wiki:MailingLists[Mailing Lists]::
+    Ask questions on the mailing lists:
+    macports-dev for base and Portfile development,
+    macports-users for user support questions
+wiki:FAQ[]::
+    Frequently Asked Questions
+wiki:ProblemHotlist[Problem Hotlist]::
+    Solutions for the most common error messages and other problems


Property changes on: trunk/base/doc/furtherdocs.txt
___________________________________________________________________
Added: svn:keywords
   + Author Date Id Rev URL
Added: svn:eol-style
   + native

Copied: trunk/base/doc/port-help.1.txt (from rev 123016, trunk/base/doc/port-contents.1.txt)
===================================================================
--- trunk/base/doc/port-help.1.txt	                        (rev 0)
+++ trunk/base/doc/port-help.1.txt	2014-08-03 21:09:18 UTC (rev 123020)
@@ -0,0 +1,31 @@
+// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
+port-help(1)
+============
+$Id$
+
+NAME
+----
+port-help - Get help on MacPorts commands
+
+SYNOPSIS
+--------
+[cmdsynopsis]
+*port* *help* ['action' | 'help-topic']
+
+DESCRIPTION
+-----------
+*port help* opens the manpage for a given port action such as 'install',
+'upgrade', 'selfupdate', etc. or a specific help topic like 'macports.conf'.
+MacPorts even has help for its help feature. MacPorts will however not engage in
+higher level abstractions: There is no help on the help on the help.
+
+include::furtherdocs.txt[]
+
+SEE ALSO
+--------
+port(1)
+
+AUTHORS
+-------
+ (C) 2014 The MacPorts Project
+ Clemens Lang <cal at macports.org>

Modified: trunk/base/doc/portundocumented.7.txt
===================================================================
--- trunk/base/doc/portundocumented.7.txt	2014-08-03 21:04:11 UTC (rev 123019)
+++ trunk/base/doc/portundocumented.7.txt	2014-08-03 21:09:18 UTC (rev 123020)
@@ -12,22 +12,8 @@
 Unfortunately, the requested topic is not yet documented in the MacPorts man
 pages. Sorry.
 
-Further documentation on MacPorts can be found in the following places:
+include::furtherdocs.txt[]
 
-guide:[The MacPorts Guide]::
-    Detailed help and support guide
-wiki:[The MacPorts Wiki]::
-    MacPorts usage, development, and support
-wiki:MailingLists[Mailing Lists]::
-    Ask questions on the mailing lists:
-    macports-dev for base and Portfile development,
-    macports-users for user support questions
-wiki:FAQ[]::
-    Frequently Asked Questions
-wiki:ProblemHotlist[Problem Hotlist]::
-    Solutions for the most common error messages and other problems
-
-
 CONTRIBUTING
 ------------
 All sort of contributions to MacPorts base, ports and especially the
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/macports-changes/attachments/20140803/0d9b8d8b/attachment-0001.html>