Manual.md: document vextract, vsrcextract, vsrccopy

This commit is contained in:
classabbyamp 2024-01-03 15:39:01 -05:00 committed by classabbyamp
parent a2ef8bf5ed
commit 278139018d
1 changed files with 23 additions and 0 deletions

View File

@ -335,6 +335,29 @@ The following functions are defined by `xbps-src` and can be used on any templat
it will default to `pkgname`. The `shell` argument can be one of `bash`,
`fish` or `zsh`.
- *vextract()* `[-C <target directory>] [--no-strip-components|--strip-components=<n>] <file>`
Extracts `file` to `target directory` with `n` directory components stripped. If
`target directory` not specified, defaults to the working directory. If
`--strip-components` or `--no-strip-components` is not specified, defaults to
`--strip-components=1`.
- *vsrcextract()* `[-C <target directory>] [--no-strip-components|--strip-components=<n>] <file>`
Extracts `$XBPS_SRCDISTDIR/$pkgname-$version/<file>` to `target directory`
with `n` directory components stripped. If `target directory` not specified,
defaults to the working directory. If `--strip-components` or `--no-strip-components`
is not specified, defaults to `--strip-components=1`.
This is useful when used in conjunction with `skip_extraction` and for submodule distfiles.
- *vsrccopy()* `<file>... <target>`
Copies `file`s from `$XBPS_SRCDISTDIR/$pkgname-$version/` into the `target` directory,
creating `target` if it does not exist.
This is useful when used in conjunction with `skip_extraction`.
> Shell wildcards must be properly quoted, Example: `vmove "usr/lib/*.a"`.
<a id="global_vars"></a>