[51331] branches/new-help-system/base/doc
raimue at macports.org
raimue at macports.org
Fri May 22 20:57:22 PDT 2009
Revision: 51331
http://trac.macports.org/changeset/51331
Author: raimue at macports.org
Date: 2009-05-22 20:57:22 -0700 (Fri, 22 May 2009)
Log Message:
-----------
doc: New man page port-edit
Modified Paths:
--------------
branches/new-help-system/base/doc/Makefile
Added Paths:
-----------
branches/new-help-system/base/doc/port-edit.1
branches/new-help-system/base/doc/port-edit.1.txt
Modified: branches/new-help-system/base/doc/Makefile
===================================================================
--- branches/new-help-system/base/doc/Makefile 2009-05-23 03:53:39 UTC (rev 51330)
+++ branches/new-help-system/base/doc/Makefile 2009-05-23 03:57:22 UTC (rev 51331)
@@ -2,6 +2,7 @@
MAN1= port.1 \
port-activate.1 \
port-deactivate.1 \
+ port-edit.1 \
port-install.1 \
port-uninstall.1
MAN5= macports.conf.5
Added: branches/new-help-system/base/doc/port-edit.1
===================================================================
--- branches/new-help-system/base/doc/port-edit.1 (rev 0)
+++ branches/new-help-system/base/doc/port-edit.1 2009-05-23 03:57:22 UTC (rev 51331)
@@ -0,0 +1,78 @@
+'\" t
+.\" Title: port-edit
+.\" Author: [see the "AUTHORS" section]
+.\" Generator: DocBook XSL Stylesheets v1.75.0 <http://docbook.sf.net/>
+.\" Date: 05/23/2009
+.\" Manual: MacPorts Manual
+.\" Source: MacPorts 1.8.0
+.\" Language: English
+.\"
+.TH "PORT\-EDIT" "1" "05/23/2009" "MacPorts 1\&.8\&.0" "MacPorts Manual"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+port-edit \- Open the Portfile in an editor
+.SH "SYNOPSIS"
+.sp
+.nf
+\fBport\fR [\fB\-D\fR \fIportdir\fR] \fBedit\fR
+ [\-\-editor <editor>]
+ [[\fIportname\fR | \fIpseudo\-portname\fR | \fIport\-expressions\fR | \fIport\-url\fR]]
+.fi
+.SH "DESCRIPTION"
+.sp
+\fBport edit\fR will open the associated Portfile in an editor\&. It will try to determine your favorite editor by respecting the environment variables \fB$VISUAL\fR or \fB$EDITOR\fR in this order\&. If none has been set it will fallback to \fI/usr/bin/vi\fR\&. Your shell will be blocked until the editor returns\&. The path to the Portfile is passed as one single argument to the editor\&.
+.sp
+If you specify multiple ports, the editor is executed multiple times for each of them one after another\&.
+.if n \{\
+.sp
+.\}
+.RS 4
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+\fBNote\fR
+.ps -1
+.br
+.sp
+If you edit a \fIPortfile\fR, your changes might be lost on the next sync\&. If you want to permanently use a changed \fIPortfile\fR, copy it to a local ports tree and edit it there\&. See also http://guide\&.macports\&.org/#development\&.local\-repositories
+.sp .5v
+.RE
+.SH "OPTIONS"
+.PP
+\fB\-\-editor <editor>\fR
+.RS 4
+Use the specified
+\fIeditor\fR, overriding environment variables\&.
+.RE
+.SH "ENVIRONMENT"
+.PP
+\fBEDITOR\fR, \fBVISUAL\fR
+.RS 4
+Specifies the editor to be launched\&.
+.RE
+.SH "SEE ALSO"
+.sp
+port(1), port\-file(1), port\-cat(1)
+.SH "AUTHORS"
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+(C) 2009 The MacPorts Project
+(C) 2009 Rainer Mueller <raimue at macports\&.org>
+.fi
+.if n \{\
+.RE
+.\}
Added: branches/new-help-system/base/doc/port-edit.1.txt
===================================================================
--- branches/new-help-system/base/doc/port-edit.1.txt (rev 0)
+++ branches/new-help-system/base/doc/port-edit.1.txt 2009-05-23 03:57:22 UTC (rev 51331)
@@ -0,0 +1,52 @@
+// $Id$
+// vim: set et sw=4 ts=8 syntax=asciidoc tw=80:
+port-edit(1)
+============
+
+NAME
+----
+port-edit - Open the Portfile in an editor
+
+SYNOPSIS
+--------
+[verse]
+*port* [*-D* 'portdir'] *edit*
+ [--editor <editor>]
+ [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
+
+DESCRIPTION
+-----------
+*port edit* will open the associated Portfile in an editor. It will try to
+determine your favorite editor by respecting the environment variables *$VISUAL*
+or *$EDITOR* in this order. If none has been set it will fallback to
+'/usr/bin/vi'. Your shell will be blocked until the editor returns. The path to
+the Portfile is passed as one single argument to the editor.
+
+If you specify multiple ports, the editor is executed multiple times for
+each of them one after another.
+
+[NOTE]
+If you edit a 'Portfile', your changes might be lost on the next sync. If you
+want to permanently use a changed 'Portfile', copy it to a local ports tree and
+edit it there. See also
+http://guide.macports.org/#development.local-repositories
+// TODO: linking above needs improvement
+
+OPTIONS
+-------
+*--editor <editor>*::
+Use the specified 'editor', overriding environment variables.
+
+ENVIRONMENT
+-----------
+*EDITOR*, *VISUAL*::
+Specifies the editor to be launched.
+
+SEE ALSO
+--------
+linkman:port[1], linkman:port-file[1], linkman:port-cat[1]
+
+AUTHORS
+-------
+ (C) 2009 The MacPorts Project
+ (C) 2009 Rainer Mueller <raimue at macports.org>
Property changes on: branches/new-help-system/base/doc/port-edit.1.txt
___________________________________________________________________
Added: svn:keywords
+ Id
Added: svn:eol-style
+ native
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/macports-changes/attachments/20090522/98cb8a42/attachment.html>
More information about the macports-changes
mailing list