diff options
author | Freddy List <xtools@freddylist.xyz> | 2023-01-31 11:44:18 +0100 |
---|---|---|
committer | Leah Neukirchen <leah@vuxu.org> | 2023-01-31 14:39:07 +0100 |
commit | 1a66b5e4e96c811b2c3e58cabcdc4bf185d80810 (patch) | |
tree | 8f72c6c452d5fbac8657e0b14fbc48412ea90dfd /README | |
parent | d4350836360f764d5c4f361a458e0c6cc140b3bf (diff) | |
download | xtools-1a66b5e4e96c811b2c3e58cabcdc4bf185d80810.tar.gz xtools-1a66b5e4e96c811b2c3e58cabcdc4bf185d80810.tar.xz xtools-1a66b5e4e96c811b2c3e58cabcdc4bf185d80810.zip |
Isolate optional arguments in docs
Closes: #282 [via git-merge-pr]
Diffstat (limited to 'README')
-rw-r--r-- | README | 59 |
1 files changed, 39 insertions, 20 deletions
diff --git a/README b/README index a625c77..1e4f172 100644 --- a/README +++ b/README @@ -10,7 +10,7 @@ COMMANDS xbuildbarf [arch] – Spy on current buildbot output - xbulk [-n [-k [xbps-src flags pkgs ...]]] + xbulk [-n] [-k] [xbps-src flags] pkgs ... – simple XBPS bulk builder -n dry-run mode -k keep going on errors @@ -34,7 +34,7 @@ COMMANDS xdbg pkgs ... – list debugging packages for pkgs and recursive dependencies - xdiff [-u | -l [basedir]] + xdiff [-u | -l] [basedir] – merge/diff/list XBPS .new-* files -l list .new files -u print unified diffs @@ -48,11 +48,12 @@ COMMANDS xetcchanges – show diff of /etc against binary packages - xgensum [-f [-c [-i template]]] + xgensum [-f] [-c] [-i] [-H hostdir] template – update SHA256 sum in templates -f force (re-)download of distfiles -c use content checksum -i replace checksum in-place + -H absolute path to hostdir xgrep pattern pkgs ... – search files limited to XBPS package contents @@ -71,11 +72,11 @@ COMMANDS xlint template | pkgname | :pkgname | : – scan XBPS template for common mistakes - - use ':pkgname' to lint template as staged in the git index - - use ':' to lint all templates staged in the git index + - use ‘:pkgname’ to lint template as staged in the git index + - use ‘:’ to lint all templates staged in the git index - xlocate - [-g | -S | pattern] – locate files in all XBPS packages + xlocate -g | -S | pattern + – locate files in all XBPS packages -g Update a git based xlocate database, useful for local repositories -S Sync with the official git based xlocate database, which is @@ -96,28 +97,22 @@ COMMANDS xmypkgs [email] – list all pkgs maintained by you - xnew [-a pkg [subpkgs ...]] + xnew [-a] pkg [subpkgs ...] – create XBPS template -a append subpkgs to existing pkg - xnodev – list not installed -devel packages for installed packages - - xoptdiff [-q [pkgs ...]] + xoptdiff [-q] [pkgs ...] – show template options which differ from binary package -q quiet mode, show package names only xpcdeps pcfile ... – finds package matching the Requires: section of pkg-config files - xpkg [-R repo [-r rootdir [-amOHDvV]]] + xpkg [-amOHDvV] [-r rootdir] [-R repo] – convenient package lister - -R repo - consider only packages from repo - -r rootdir - specifies a full path for the target root directory -a list all packages (default: only installed) -m list manual packages -O list orphaned packages @@ -126,19 +121,43 @@ COMMANDS -L list installed packages not from remote repos -v show version numbers -V show version numbers and description + -r rootdir + specifies a full path for the target root directory + -R repo + consider only packages from repo + + xpkgdiff [-Sfrxt] [-a arch] [-R url] [-c file] [-p prop,...] pkg + – compare a package in the repositories to the locally-built version + - run from within a void-packages checkout + - set DIFF to change the diff program used + -S compare package metadata + -f compare package file lists + -r reverse diff (compare local to remote) + -x compare package dependencies + -t compare the full package dependency tree. Only used with -x + (equivalent to xbps-query --fulldeptree -x) + -a arch + set architecture for comparison + -R url + set remote repository url + -c file + compare a file from the package (equivalent to xbps-query --cat) + -p prop,... + compare properties of the package xpstree – display tree view of xbps-src processes - xq [-R pkg ...] + xq [-R] pkg ... – query information about XBPS package -R query remote repos xrecent [repourl | arch] – list packages in repo ordered by build date - xrevbump message templates ... - – increase template revision and commit + xrevbump message templates ... [-- git commit options] + – increase template revision and commit. Use ‘-’ to read templates + from stdin. xrevshlib package – list packages shlib-dependent on package or its subpackages @@ -149,7 +168,7 @@ COMMANDS xsrc pkg – list source files for XBPS template - xsubpkg [-m pkg] + xsubpkg [-m] pkg – list all subpackages of a package -m only print main package |