|author||Luke Shumaker <LukeShu@sbcglobal.net>||2014-05-15 22:25:43 -0400|
|committer||Luke Shumaker <LukeShu@sbcglobal.net>||2014-05-15 22:25:43 -0400|
librefetch: clean up documentationv20140515
Diffstat (limited to 'src/librefetch/librefetch.8.ronn')
1 files changed, 11 insertions, 4 deletions
diff --git a/src/librefetch/librefetch.8.ronn b/src/librefetch/librefetch.8.ronn
index d7b8edc..bb2e561 100644
@@ -12,9 +12,9 @@ librefetch(8) -- downloads or creates a liberated source tarball
tarballs for `PKGBUILD(5)` files.
If a URL mentioned in the `source` array in a `PKGUILD` is in a
-location that Parabola uploads "custom" source tarballs (or configured
-locations), and no file is at that URL, librefetch will automatically
-create it for you.
+location that Parabola uploads "custom" source tarballs to (or
+configured locations), and no file is at that URL, librefetch will
+automatically create it for you.
This works because a post-install script for the package configures
`librefetch` as the download agent for `https://` URLs in
@@ -53,6 +53,9 @@ fails, it may choose to try `create` mode.
* `-h` | `--help`: Use `help` mode: Show useage information.
+Other options, if they are documented in `makepkg -h`, are passed to
+the modified copy of makepkg created during `create` mode.
## DOWNLOAD MODE
If <SOURCE-URL> begins with the string `libre://`, it is replaced with
@@ -97,7 +100,7 @@ remain intact.
As explained in the `CREATE MODE` section, in `create` mode, this
program generates an `SRCBUILD` file. For debugging purposes, this
-file can be printed instead of executed with `print` mode.
+file can be printed instead of executed with `srcbuild` mode.
### PRE-EXISTING SRCBUILD
@@ -184,6 +187,10 @@ The following modifications are made to makepkg:
* append `-libre` to `$pkgbasedir` (which becomes `$pkgdir`)
* Don't check if the package has already been built.
+For debugging purposes, this modified makepkg can be printed instead
+of executed with `makepkg` mode. Before it is run in create mode,
+`PKGEXT`, `PKGDEST`, and `pkg_file` are set as environment variables.
See `librefetch.conf(5)` for details on configuring librefetch using