From 6c5138ba7e65358441641a2922bf843ea1127699 Mon Sep 17 00:00:00 2001 From: classabbyamp Date: Wed, 3 Jan 2024 15:39:01 -0500 Subject: [PATCH] Manual.md: document vextract, vsrcextract, vsrccopy --- Manual.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/Manual.md b/Manual.md index e6a98551eee30..969d2ccc01e8f 100644 --- a/Manual.md +++ b/Manual.md @@ -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 ] [--no-strip-components|--strip-components=] ` + + 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 ] [--no-strip-components|--strip-components=] ` + + Extracts `$XBPS_SRCDISTDIR/$pkgname-$version/` 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()* `... ` + + 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"`.