From dadcaee9f9692c07020af99dc84a18bec50df4c4 Mon Sep 17 00:00:00 2001 From: Christopher Sexton Date: Thu, 3 Jun 2010 22:29:20 -0700 Subject: Man page for Homebrew Includes: generator script, ronn source, manpage output Signed-off-by: Adam Vandenberg Man page updates. * Generator command is now an external command with additional options * Added more brew commands * Tweaks and reformats --- Library/Contributions/examples/brew-man | 37 +++++++ Library/Contributions/manpages/brew.1.md | 160 +++++++++++++++++++++++++++++++ 2 files changed, 197 insertions(+) create mode 100755 Library/Contributions/examples/brew-man create mode 100644 Library/Contributions/manpages/brew.1.md (limited to 'Library') diff --git a/Library/Contributions/examples/brew-man b/Library/Contributions/examples/brew-man new file mode 100755 index 000000000..9bc34be4a --- /dev/null +++ b/Library/Contributions/examples/brew-man @@ -0,0 +1,37 @@ +#!/bin/bash + +set -e + +man1_suffix="share/man/man1/brew.1" +source_path="$HOMEBREW_REPOSITORY/Library/Contributions/manpages" +target_file="$HOMEBREW_REPOSITORY/$man1_suffix" + + +die (){ + echo $1 + exit 1 +} + +test "$1" = '--link' || \ +test "$1" = '-l' && { + ln -s "$target_file" "$HOMEBREW_PREFIX/$man1_suffix" + exit 0 +} + +/usr/bin/which -s ronn || die "You need to \"gem install ronn\" and put it in your path." + +test "$1" = '--server' || \ +test "$1" = '-s' && { + echo "Manpage test server: http://localhost:1207/" + echo "Control-C to exit." + ronn --server $source_path/* + exit 0 +} + +echo "Writing manpage to $target_file" +ronn --roff --pipe --organization='Homebrew' --manual='brew' $source_path/brew.1.md > $target_file + +test "$1" = '--verbose' || \ +test "$1" = '-v' && { + man brew +} diff --git a/Library/Contributions/manpages/brew.1.md b/Library/Contributions/manpages/brew.1.md new file mode 100644 index 000000000..828428eaf --- /dev/null +++ b/Library/Contributions/manpages/brew.1.md @@ -0,0 +1,160 @@ +The missing package manager for OS X +==================================== + +## SYNOPSIS + +`brew` [--verbose|-v] command [options] [formula] ... +`brew` [--version|-v] + +## DESCRIPTION + +Homebrew is the easiest and most flexible way to install the UNIX tools Apple +didn't include with OS X. + +## OPTIONS + * `-v`, `--verbose` command [options] [formula] ...: + Prints extra, comand-specific debugging information. + Note that `brew -v` by itself is the same as `brew --version`. + +## COMMANDS + + * `-v`, `--version`: + Prints the version number of brew to standard error and exits. + + * `--prefix` []: + Displays the install path for Homebrew. + If is given, display location in the cellar where that package + is or would be installed. + + * `--cache` []: + Displays the path Homebrew uses to cache downloads. + If is given, display the file or folder used to cache that specific package. + + * `--config`: + Shows Homebrew and system configuration useful for debugging. If you file + a bug report, you will likely be asked for this information if you do not + provide it. + + * `-S`, `search` |//: + Performs a substring search of formula names for . If is + surrounded with slashes, then it is interpreted as a regular expression. + If no search term is given, all available formula are displayed. + + * `install [--debug]` : + Installs . + + If `--debug` is passed and brewing fails, opens a shell inside the + temporary folder used for compiling. + + * `install --interactive [--git]` : + Downloads and patches , and then opens a shell. This allows the + user to run `./configure --help` and otherwise determine how to turn the + software package into a Homebrew formula. + + If `--git` is passed, Homebrew will create a Git repository, useful for + creating patches to the software. + + * `list`: + Lists all installed formulae. + + * `list` : + Lists the installed files for . + + * `info` : + Gives all available information for . + + * `info --github` : + Opens a browser to the GitHub History page for formula . + + * `info --all`: + Summarises all installed packages; this is inteded to be used by + higher-level tools. + + * `home`: + Opens a browser to Homebrew's own homepage. + + * `home` : + Opens a browser to 's homepage. + + * `rm`, `remove` : + Uninstalls . + + * `create [--cache]` : + Generates a formula for the downloadable file at and opens it in + $EDITOR. Homebrew will attempt to automatically derive the formula name + and version, if it fails, you'll have to make your own template. I suggest + copying wget's. + + If `--cache` is passed, Homebrew will download the to the cache and + add the MD5 to the formula for you. + + * `create --macports`|`--fink` : + Opens a browser to the MacPorts or Fink package search page, so you can + see how they do . + + * `edit` : + Opens the formula in $EDITOR. + + * `edit`: + Opens all of Homebrew for editing in TextMate. + + * `link` : + Symlinks all of 's installed files into the Homebrew prefix. This + is done automatically when you install formula. It is useful for DIY + installation, or in cases where you want to swap out different versions of + the same package that you have installed at the same time. + + * `unlink` : + Unsymlinks from the Homebrew prefix. + + * `prune`: + Removes dead symlinks from the Homebrew prefix. This is generally not + needed. However, it can be useful if you are doing DIY installations. + + * `outdated`: + Shows formula that have an updated version available. + + * `deps` : + Shows 's dependencies. + + * `uses` : + Shows the formulas that specify as a dependency. The list is not + recursive; only one level of dependencies is resolved. + + * `doctor`: + Audits your system for potential problems. + + * `cat` : + Displays the source to . + + * `cleanup` []: + For all installed or specific formulae, remove any older versions from the + cellar. + + * `update`: + Using Git, fetches the newest version of Homebrew from the GitHub repository. + +## ENVIRONMENT + + * HOMEBREW\_DEBUG: + If set, instructs Homebrew to always assume `--debug` when running commands. + + * HOMEBREW\_USE\_LLVM: + If set, instructs Homebrew to use the LLVM front-ends to the GCC compilers. + *NOTE*: Not all formulae will build correctly under LLVM. + + * HOMEBREW\_VERBOSE: + If set, instructs Homebrew to always assume `--verbose` when running + commands. + +## SEE ALSO + + Homebrew Wiki: http://wiki.github.com/mxcl/homebrew/ + +## AUTHORS + +Max Howell, a splendid chap. + +## BUGS + +See Issues on GitHub: http://github.com/mxcl/homebrew/issues -- cgit v1.2.3