about summary refs log tree commit diff stats
diff options
context:
space:
mode:
-rw-r--r--README.md47
1 files changed, 38 insertions, 9 deletions
diff --git a/README.md b/README.md index 096df26..95b1d9a 100644 --- a/README.md +++ b/README.md
@@ -84,6 +84,31 @@ The following variables are used when processing plans, but they're
84 - `make_install` 84 - `make_install`
85 - `configure` 85 - `configure`
86 86
87### `misc` invocation
88
89`misc` takes a number of command-line arguments. What follows is the output
90you'll get when you run `misc -h`.
91
92```
93misc: install programs from source
94--- Usage:
95 misc -h
96 misc [-d] [-n] [-r DIR] [-p DIR] REPO ...
97--- Parameters:
98 REPO A program to pull from upstream, build, and install locally.
99--- Flags:
100 -h Show this help and exit.
101 -d DRY RUN: Don't do anything, just print what would happen.
102 -n NUKE: Delete REPO, then re-download and build.
103--- Options:
104 -r DIR Change the misc repo directory to DIR
105 (default: $MISC_REPO_ROOT).
106 -p DIR Change the directory to search for install plans
107 (default: $MISC_PLAN_ROOT).
108 -i DIR Change the PREFIX to use when installing programs
109 (default: $MISC_INSTALL_PREFIX).
110```
111
87### Plans 112### Plans
88 113
89"Plans" are what `misc` calls the instruction files to install programs. There 114"Plans" are what `misc` calls the instruction files to install programs. There
@@ -115,18 +140,22 @@ find useful in a plan file.
115 140
116#### Utility functions 141#### Utility functions
117 142
118- `die CODE MESSAGE...` 143- `die CODE MESSAGE...`: output MESSAGE to standard error and exit with CODE.
119- `run COMMAND...` 144- `run COMMAND...`: log COMMAND, then execute it if not in dry-run mode.
120- `cmd COMMAND...` 145- `cmd COMMAND...`: the same as `run`, but uses `command` instead of `eval`.
121- `with_repo COMMAND...` 146- `with_repo COMMAND...`: `cd` to `$MISC_REPO`, then execute COMMAND.
122 147
123#### Building and installation functions 148#### Building and installation functions
124 149
125- `install_deps` 150- `install_deps`: install the dependencies in `$MISC_DEPENDENCIES` and `$APT_DEPENDENCIES`.
126- `repo_pull [CHECKOUT]` 151- `repo_pull [CHECKOUT]`: pull the repo from `$SOURCE`, a git repository. If
127- `repo_download_extract` 152 CHECKOUT is given, use that branch; otherwise use `master`.
128- `repo_ready [TARGET...]` 153- `repo_download_extract`: download `$SOURCE` using `curl`, then untar it. This
129- `repo_nuke` 154 expects the source URL to be a `.tar.gz` file.
155- `repo_ready [TARGET...]`: ready the local source directory by running `git
156 -dxf` (if applicable) and `make clean`. If TARGETs are given, use those as the
157 make targets instead of `clean`.
158- `repo_nuke`: Delete the repository altogether before re-downloading or cloning it.
130 159
131#### Plan convenience aliases 160#### Plan convenience aliases
132 161