Opened 16 years ago

Closed 15 years ago

Last modified 15 years ago

#16118 closed enhancement (fixed)

Add documentation for various port commands

Reported by: raimue (Rainer Müller) Owned by: markd@…
Priority: Normal Milestone:
Component: guide Version:
Keywords: gohome documentation Cc: blb@…
Port:

Description

The command port gohome is not documented, neither in the guide nor in the man page.

It was added in r24551.

Attachments (1)

port.1-commands.diff (2.5 KB) - added by blb@… 15 years ago.
diff to base/doc/port.1

Download all attachments as: .zip

Change History (9)

comment:1 Changed 16 years ago by raimue (Rainer Müller)

Summary: Add documentation `port gohome`Add documentation for `port gohome`

comment:2 Changed 16 years ago by blb@…

Cc: blb@… added

I'll attach a diff for port.1 to add documentation for several commands: platform, gohome, usage, work, cd, url, and ed. There are still several not listed in this diff, either because they appear to not be implemented yet (compact and uncompact) or I don't know how they work (submit, mirror, load, and unload).

comment:3 Changed 16 years ago by ryandesign (Ryan Carsten Schmidt)

"sudo port load ${port}" is a shortcut for "sudo launchctl load -w /Library/LaunchDaemons/org.macports.${port}.plist". Similarly for "sudo port unload ${port}". Added in r31500.

comment:4 Changed 16 years ago by blb@…

Updated diff adding descriptions of load and unload; thanks Ryan.

comment:5 Changed 16 years ago by raimue (Rainer Müller)

I think the description for port url is not quite correct.

Displays the MacPorts internal URL for the given portname.

It's the internal what concerns me. The value of port url can be passed as argument to any port action.

See port-url here:

SYNOPSIS
     port [-vdqfonRusbckixpt] [-D portdir] [-F cmdfile] [action] [actionflags]
          [[portname | pseudo-portname | port-url]]
          [[@version] [+/-variant ...] ... [option=value ...]]

I would say:

Displays the URL to the Portfile of the given portname, which can be passed as port-url.

There is no other description for port-url so this could help to clarify it a bit.

comment:6 Changed 15 years ago by blb@…

Summary: Add documentation for `port gohome`Add documentation for various port commands

Updating the patch to include raimue@'s improved description for port url (though the URL is the path for the port, not the Portfile itself), and added an initial section for port mirror which probably needs some improvement.

Changed 15 years ago by blb@…

Attachment: port.1-commands.diff added

diff to base/doc/port.1

comment:7 Changed 15 years ago by raimue (Rainer Müller)

Resolution: fixed
Status: newclosed

Committed the patch in r44815.

comment:8 Changed 15 years ago by (none)

Milestone: Website & Documentation

Milestone Website & Documentation deleted

Note: See TracTickets for help on using tickets.