From 8d84b6eb80063d87267372b1e943651e991c4ad3 Mon Sep 17 00:00:00 2001 From: Jakob Meier Date: Thu, 9 Nov 2023 16:38:56 +0100 Subject: [PATCH] Fixed quote formatting --- README.md | 172 +++++++++++++++++++++++++++++++++--------------------- 1 file changed, 105 insertions(+), 67 deletions(-) diff --git a/README.md b/README.md index 7bbd4e8..4e4a609 100644 --- a/README.md +++ b/README.md @@ -15,20 +15,25 @@ You can use the help command to view a command description cabin ``` -> Simple alpine package builder with dependency resolution using abuild -> Usage: cabin -> Commands: -> list Lists all known packages -> scan Rescans all folders -> build-all Build all packages in repo -> build Builds the package -> info Displays package information -> search Searches the database for a package with the name or containing the name -> tree show a list of all dependencies -> help Print this message or the help of the given subcommand(s) -> Options: -> -h, --help Print help -> -V, --version Print version +``` +Simple alpine package builder with dependency resolution using abuild + +Usage: cabin + +Commands: + list Lists all known packages + scan Rescans all folders + build-all Build all packages in repo + build Builds the package + info Displays package information + search Searches the database for a package with the name or containing the name + tree show a list of all dependencies + help Print this message or the help of the given subcommand(s) + +Options: + -h, --help Print help + -V, --version Print version +``` You can also combine the commands with `help` to view available options @@ -48,13 +53,18 @@ cabin scan cabin help scan ``` -> Searches the folder for APKBUILDs recursively and builds a local database -> Usage: cabin scan [FOLDER] [DB] -> Arguments: -> [FOLDER] workspace -> [DB] package database path -> Options: -> -h, --help Print help +``` +Searches the folder for APKBUILDs recursively and builds a local database + +Usage: cabin scan [FOLDER] [DB] + +Arguments: + [FOLDER] workspace + [DB] package database path + +Options: + -h, --help Print help +``` **NOTE**: you have to rerun the `scan` command every time the `aports` change. @@ -70,11 +80,15 @@ For a list of all options, see the help page cabin help list ``` -> Lists all known packages -> Usage: cabin list [OPTIONS] -> Options: -> -d, --db package database path -> -h, --help Print help +``` +Lists all known packages + +Usage: cabin list [OPTIONS] + +Options: + -d, --db package database path + -h, --help Print help +``` ### Search ```sh @@ -85,13 +99,18 @@ Search through package names, descriptions and urls and lists package names,vers ```sh cabin help search ``` -> Searches the database for a package with the name or containing the name -> Usage: cabin search [OPTIONS] -> Arguments: -> search query -> Options: -> -d, --db package database path -> -h, --help Print help +``` +Searches the database for a package with the name or containing the name + +Usage: cabin search [OPTIONS] + +Arguments: + search query + +Options: + -d, --db package database path + -h, --help Print help +``` ### Build @@ -108,29 +127,38 @@ if you want to use the dependency resolution / auto build feature. cabin help build ``` -> Builds the package -> Usage: cabin build [OPTIONS] -> Arguments: -> the packagename -> Options: -> -a, --arch build the package for a target architecture requires abuild-rootbld and qemu-binfmt to be installed (for the given architecture) and the .rootbld-repositories file to be configured correctly (even if set to host architecture) -> -r disables dependency resolution wont compile the dependencies locally however this will still pass -r to abuild and fetch the prebuild packages from upstream -> -d, --db package database path -> -v allows the build log to be toggled on and off -> -h, --help Print help +``` +Builds the package + +Usage: cabin build [OPTIONS] + +Arguments: + the packagename + +Options: + -a, --arch build the package for a target architecture requires abuild-rootbld and qemu-binfmt to be installed (for the given architecture) and the .rootbld-repositories file to be configured correctly (even if set to host architecture) + -r disables dependency resolution wont compile the dependencies locally however this will still pass -r to abuild and fetch the prebuild packages from upstream + -d, --db package database path + -v allows the build log to be toggled on and off + -h, --help Print help +``` ### Build All ```sh cabin help build-all ``` -> Build all packages in repo -> Usage: cabin build-all [OPTIONS] -> Options: -> -a, --arch build the package for a target architecture requires abuild-rootbld and qemu-binfmt to be installed (for the given architecture) and the .rootbld-repositories file to be configured correctly (even if set to host architecture) -> -d, --db package database path -> -v allows the build log to be toggled on and off -> -h, --help Print help +``` +Build all packages in repo + +Usage: cabin build-all [OPTIONS] + +Options: + -a, --arch build the package for a target architecture requires abuild-rootbld and qemu-binfmt to be installed (for the given architecture) and the .rootbld-repositories file to be configured correctly (even if set to host architecture) + -d, --db package database path + -v allows the build log to be toggled on and off + -h, --help Print help +``` ### Build Group Allows building multiple packages in topologically sorted order. @@ -138,15 +166,20 @@ Allows building multiple packages in topologically sorted order. cabin build-group [...packages] ``` -> Builds multiple packages from a list -> Usage: cabin build-group [OPTIONS] [PACKAGES]... -> Arguments: -> [PACKAGES]... list of packages to be build -> Options: -> -a, --arch build the package for a target architecture requires abuild-rootbld and qemu-binfmt to be installed (for the given architecture) and the .rootbld-repositories file to be configured correctly (even if set to host architecture) -> -d, --db package database path -> -v allows the build log to be toggled on and off -> -h, --help Print help +``` +Builds multiple packages from a list + +Usage: cabin build-group [OPTIONS] [PACKAGES]... + +Arguments: + [PACKAGES]... list of packages to be build + +Options: + -a, --arch build the package for a target architecture requires abuild-rootbld and qemu-binfmt to be installed (for the given architecture) and the .rootbld-repositories file to be configured correctly (even if set to host architecture) + -d, --db package database path + -v allows the build log to be toggled on and off + -h, --help Print help +``` ### Tree @@ -154,14 +187,19 @@ cabin build-group [...packages] cabin help tree ``` -> show a list of all dependencies -> Usage: cabin tree [OPTIONS] -> Arguments: -> the packagename -> Options: -> -d, --db package database path -> -l shows only local dependencies, that can be found in the local database will also topologically sort the dependencies -> -h, --help Print help +``` +show a list of all dependencies + +Usage: cabin tree [OPTIONS] + +Arguments: + the packagename + +Options: + -d, --db package database path + -l shows only local dependencies, that can be found in the local database will also topologically sort the dependencies + -h, --help Print help +``` ## Dependencies ### Compile-time -- 2.38.5