diff --git a/docs/deb-get.1 b/docs/deb-get.1 index 490530934..976c7c511 100644 --- a/docs/deb-get.1 +++ b/docs/deb-get.1 @@ -1,30 +1,12 @@ -.\" Automatically generated by Pandoc 2.19.2 +.\" Automatically generated by Pandoc 3.1.9 .\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} .TH "deb-get" "1" "February 14, 2022" "deb-get" "deb-get User Manual" -.hy .SH NAME -.PP deb-get - An installation manager for 3rd-Party deb packages .SH SYNOPSIS -.PP \f[B]deb-get\f[R] [\f[I]COMMAND\f[R]]\&... .IP -.nf -\f[C] +.EX deb-get {update [--repos-only] [--quiet] | upgrade | show | install | reinstall | remove [--remove-repo] | purge [--remove-repo] @@ -32,10 +14,8 @@ deb-get {update [--repos-only] [--quiet] | upgrade | show | install < | list [--include-unsupported] [--raw|--installed|--not-installed] | prettylist [] | csvlist [] | fix-installed [--old-apps] | help | version} -\f[R] -.fi +.EE .SH DESCRIPTION -.PP deb-get provides a high-level commandline interface for the package management system to easily install and update packages published in 3rd party apt repositories or via direct download. @@ -130,57 +110,49 @@ show this help. show deb-get version. .SH EXAMPLES .SS Introduction -.PP -\f[V]deb-get\f[R] makes it easy to install and update \f[V].debs\f[R] +\f[CR]deb-get\f[R] makes it easy to install and update \f[CR].debs\f[R] published in 3rd party apt repositories or made available via direct download on websites or GitHub release pages. .SS Install -.PP -Use \f[V]deb-get\f[R] to install \f[V]deb-get\f[R]. +Use \f[CR]deb-get\f[R] to install \f[CR]deb-get\f[R]. .IP -.nf -\f[C] +.EX sudo apt install curl curl -sL https://raw.githubusercontent.com/wimpysworld/deb-get/main/deb-get | sudo -E bash -s install deb-get -\f[R] -.fi +.EE .PP -Alternatively, you can download the \f[V].deb\f[R] of \f[V]deb-get\f[R] -from the releases -page (https://github.com/wimpysworld/deb-get/releases/latest) and -install it manually with +Alternatively, you can \c +.UR https://github.com/wimpysworld/deb-get/releases/latest +download the \f[CR].deb\f[R] of \f[CR]deb-get\f[R] from the releases +page +.UE \c +\ and install it manually with .IP -.nf -\f[C] +.EX sudo apt-get install ./path/to/deb-get_.deb -\f[R] -.fi +.EE .SS Usage -.PP Here\[cq]s an example of how to install Google Chrome. .IP -.nf -\f[C] +.EX deb-get install google-chrome-stable -\f[R] -.fi +.EE .PP You can see what applications are supported by using -\f[V]deb-get list\f[R] or you can search the available applications with -\f[V]deb-get search \f[R]. +\f[CR]deb-get list\f[R] or you can search the available applications +with \f[CR]deb-get search \f[R]. .PP -You can upgrade packages installed using \f[V]deb-get\f[R] by running -\f[V]deb-get upgrade\f[R]. +You can upgrade packages installed using \f[CR]deb-get\f[R] by running +\f[CR]deb-get upgrade\f[R]. .SS Why? -.PP 3rd party apt repositories exist. They are not going away. .PP Some application vendors and projects express their support for -Debian/Ubuntu by publishing \f[V].debs\f[R] of their software as direct +Debian/Ubuntu by publishing \f[CR].debs\f[R] of their software as direct downloads or via their own apt repositories. -\f[V]deb-get\f[R] makes it easy to find, install and update -\f[V].debs\f[R] published in this way. +\f[CR]deb-get\f[R] makes it easy to find, install and update +\f[CR].debs\f[R] published in this way. .IP \[bu] 2 Perhaps you want to use software that is not (yet) officially packaged for Debian/Ubuntu. @@ -191,72 +163,87 @@ are available from the vendor/project. Perhaps you want to use some non-free software that Debian/Ubuntu cannot distribute due to licensing restrictions. .PP -\f[V]deb-get\f[R] tries to remedy this by providing a curated index of +\f[CR]deb-get\f[R] tries to remedy this by providing a curated index of software available for Ubuntu that is published by the project or vendor. -\f[V]deb-get\f[R] is inspired by Software Boutique, a graphical +\f[CR]deb-get\f[R] is inspired by Software Boutique, a graphical application I co-authored that does much the same thing and has been -included in Ubuntu MATE (https://ubuntu-mate.org) since 2015. +included in \c +.UR https://ubuntu-mate.org +Ubuntu MATE +.UE \c +\ since 2015. .SS Supported Software -.PP The list of the software that can be installed, updated and removed -using \f[V]deb-get\f[R]\[cq]s main repository is available at -01-main/README (https://github.com/wimpysworld/deb-get/blob/main/01-main/README.md). +using \f[CR]deb-get\f[R]\[cq]s main repository is available at \c +.UR https://github.com/wimpysworld/deb-get/blob/main/01-main/README.md +01-main/README +.UE \c +\&. .SS How do package updates work? .SS 3rd party apt repositories and PPAs -.PP -If packages are available via a 3rd party \f[V]apt\f[R] repository or a +If packages are available via a 3rd party \f[CR]apt\f[R] repository or a Launchpad PPA, then those packages will be updated/upgraded when using -\f[V]sudo apt-get update\f[R] and \f[V]sudo apt-get upgrade\f[R]. +\f[CR]sudo apt-get update\f[R] and \f[CR]sudo apt-get upgrade\f[R]. .SS GitHub Releases and direct downloads -.PP -For \f[V].deb\f[R] packages that are only available via GitHub Releases +For \f[CR].deb\f[R] packages that are only available via GitHub Releases or direct download, then those packages can only be updated/upgraded by -using \f[V]deb-get update\f[R] and \f[V]deb-get upgrade\f[R]. +using \f[CR]deb-get update\f[R] and \f[CR]deb-get upgrade\f[R]. .SS GitHub API Rate Limits -.PP -\f[V]deb-get\f[R] uses the GitHub REST -API (https://docs.github.com/en/rest) for some functionality when -applications are provided via GitHub Releases and for unauthenticated -interactions this API is -rate-limited (https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting) -to 60 calls per hour per source (IP Address). +\f[CR]deb-get\f[R] uses the \c +.UR https://docs.github.com/en/rest +GitHub REST API +.UE \c +\ for some functionality when applications are provided via GitHub +Releases and for unauthenticated interactions this API is \c +.UR +https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting +rate-limited +.UE \c +\ to 60 calls per hour per source (IP Address). This is vital for keeping the API responsive and available to all users, but can be inconvenient if you have a lot of GitHub releases being -handled by \f[V]deb-get\f[R] (or need to update several times in a short -period to test your -contribution (https://github.com/wimpysworld/deb-get/blob/main/01-main/CONTRIBUTING.md)) -and will result in, for example, temporary failures to be able to +handled by \f[CR]deb-get\f[R] (or need to update several times in a +short period to test your \c +.UR +https://github.com/wimpysworld/deb-get/blob/main/01-main/CONTRIBUTING.md +contribution +.UE \c +) and will result in, for example, temporary failures to be able to upgrade or install applications via GitHub Releases. .PP If you have a GitHub account you can authenticate your GitHub API usage to increase your rate-limit to 5000 requests per hour per authenticated user. -To do this you will need to use a Personal Access Token -(PAT) (https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). +To do this you will need to use a \c +.UR +https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token +Personal Access Token (PAT) +.UE \c +\&. Once you have created a token within GitHub (or identified an appropriate existing token) you should insert it into an environment -variable (\f[V]DEBGET_TOKEN\f[R]) for \f[V]deb-get\f[R] to pick up and +variable (\f[CR]DEBGET_TOKEN\f[R]) for \f[CR]deb-get\f[R] to pick up and use to authenticate to the GitHub API. .PP e.g.: .IP -.nf -\f[C] +.EX export DEBGET_TOKEN= deb-get update deb-get upgrade -\f[R] -.fi +.EE .SS Adding Software -.PP For information on what is acceptable as suggestion for new packages and instructions on how to open a PR to add a new package to the main -repository, head to -01-main/CONTRIBUTING (https://github.com/wimpysworld/deb-get/blob/main/01-main/CONTRIBUTING.md). +repository, head to \c +.UR +https://github.com/wimpysworld/deb-get/blob/main/01-main/CONTRIBUTING.md +01-main/CONTRIBUTING +.UE \c +\&. .SS Adding external repositories -.PP -It is possible to also add a \f[V]deb-get\f[R]-compatible external +It is possible to also add a \f[CR]deb-get\f[R]-compatible external repository, and supplement the list of supported packages, typically because you need to: .IP "1." 3 @@ -266,31 +253,33 @@ main repository; or Change the definition of a package from the main repository. .PP For information on how to create and maintain a -\f[V]deb-get\f[R]-compatible external repository, head to -EXTREPO (https://github.com/wimpysworld/deb-get/blob/main/EXTREPO.md). +\f[CR]deb-get\f[R]-compatible external repository, head to \c +.UR https://github.com/wimpysworld/deb-get/blob/main/EXTREPO.md +EXTREPO +.UE \c +\&. .PP How to use: .IP \[bu] 2 -Manually create the file \f[V]/etc/deb-get/-.repo\f[R], +Manually create the file \f[CR]/etc/deb-get/-.repo\f[R], containing in its first line the base URL of the repository. .RS 2 .IP \[bu] 2 -The \f[V]\f[R] value is a two-digit number between 00 and 99 +The \f[CR]\f[R] value is a two-digit number between 00 and 99 that defines the order in which the repositories will be loaded (00 first, 99 last), so if any conflicting definitions are found, the one from the repository with the highest priority will be used (the builtin -definitions from the \f[V]deb-get\f[R] script itself have priority 00, +definitions from the \f[CR]deb-get\f[R] script itself have priority 00, the main repository has priority 01 and the custom user includes have priority 99). .IP \[bu] 2 -The \f[V]\f[R] value can be anything, but it should preferably be +The \f[CR]\f[R] value can be anything, but it should preferably be unique and easy to remember. .RE .IP \[bu] 2 -Run \f[V]deb-get update\f[R], so the manifest file and the package +Run \f[CR]deb-get update\f[R], so the manifest file and the package definition files are downloaded. .SS Custom User Includes -.PP As a more advanced feature, it is possible to also add your own local customizations or overrides, and supplement the list of packages supported by the main repository. @@ -310,19 +299,23 @@ guidelines of the main repository, for whatever various reason(s). .PP How to use: .IP \[bu] 2 -Manually create the folder \f[V]/etc/deb-get/99-local.d/\f[R] if it does -not exist already. -By default, \f[V]deb-get\f[R] does not create this folder unless your +Manually create the folder \f[CR]/etc/deb-get/99-local.d/\f[R] if it +does not exist already. +By default, \f[CR]deb-get\f[R] does not create this folder unless your specific distribution has packaged it that way. .IP \[bu] 2 Any files directly within this folder will be bash sourced -e.g.\ \f[V]. /etc/deb-get/99-local.d/appname1\f[R]. +e.g.\ \f[CR]. /etc/deb-get/99-local.d/appname1\f[R]. .IP \[bu] 2 The name of the added file \f[B]must\f[R] match \f[B]exactly\f[R] the name of the package being defined. .IP \[bu] 2 -For information on how to create a package definition file, head to -EXTREPO (https://github.com/wimpysworld/deb-get/blob/main/EXTREPO.md#the-package-definition-files). +For information on how to create a package definition file, head to \c +.UR +https://github.com/wimpysworld/deb-get/blob/main/EXTREPO.md#the-package-definition-files +EXTREPO +.UE \c +\&. .IP \[bu] 2 Your user custom package definition files are then loaded after the package definitions from any added repository. @@ -347,66 +340,114 @@ that we can share those back with the wider community. Many thanks for your consideration! .SS Related projects .IP \[bu] 2 -App Outlet (https://app-outlet.github.io/): \f[I]A Universal linux app -store\f[R] +\c +.UR https://app-outlet.github.io/ +App Outlet +.UE \c +: \f[I]A Universal linux app store\f[R] .IP \[bu] 2 -bin-get (https://github.com/OhMyMndy/bin-get): \f[I]Script to easily and -safely fetch binaries from Github Releases/tags\f[R] +\c +.UR https://github.com/OhMyMndy/bin-get +bin-get +.UE \c +: \f[I]Script to easily and safely fetch binaries from Github +Releases/tags\f[R] .IP \[bu] 2 -makedeb (https://www.makedeb.org/): \f[I]A simplicity-focused packaging -tool for Debian archives\f[R] +\c +.UR https://www.makedeb.org/ +makedeb +.UE \c +: \f[I]A simplicity-focused packaging tool for Debian archives\f[R] .IP \[bu] 2 -MakeResolveDeb (https://www.danieltufvesson.com/makeresolvedeb): -\f[I]Install DaVinci Resolve or DaVinci Resolve Studio on Debian\f[R] +\c +.UR https://www.danieltufvesson.com/makeresolvedeb +MakeResolveDeb +.UE \c +: \f[I]Install DaVinci Resolve or DaVinci Resolve Studio on Debian\f[R] .IP \[bu] 2 -pacstall (https://pacstall.dev/): \f[I]The AUR alternative for -Ubuntu\f[R] +\c +.UR https://pacstall.dev/ +pacstall +.UE \c +: \f[I]The AUR alternative for Ubuntu\f[R] .IP \[bu] 2 -Ubuntu Make (https://github.com/ubuntu/ubuntu-make): \f[I]Easy setup of -common tools for developers on Ubuntu.\f[R] +\c +.UR https://github.com/ubuntu/ubuntu-make +Ubuntu Make +.UE \c +: \f[I]Easy setup of common tools for developers on Ubuntu.\f[R] .IP \[bu] 2 -unsnap (https://github.com/popey/unsnap): \f[I]Quickly migrate from -using snap packages to flatpaks\f[R] ## In the media +\c +.UR https://github.com/popey/unsnap +unsnap +.UE \c +: \f[I]Quickly migrate from using snap packages to flatpaks\f[R] ## In +the media .IP \[bu] 2 +\c +.UR +https://www.gamingonlinux.com/2022/05/the-deb-get-tool-helps-ubuntu-and-derivative-distro-fans-grab-extra-apps/ The deb-get tool helps Ubuntu (and derivative distro) fans grab extra -apps (https://www.gamingonlinux.com/2022/05/the-deb-get-tool-helps-ubuntu-and-derivative-distro-fans-grab-extra-apps/) -- \f[B]GamingOnLinux\f[R] +apps +.UE \c +\ - \f[B]GamingOnLinux\f[R] .IP \[bu] 2 -Deb-Get is `Apt-Get' for 3rd-Party Ubuntu -Software (https://www.omgubuntu.co.uk/2022/05/use-deb-get-to-install-popular-linux-apps-on-ubuntu) -- \f[B]omg! +\c +.UR +https://www.omgubuntu.co.uk/2022/05/use-deb-get-to-install-popular-linux-apps-on-ubuntu +Deb-Get is `Apt-Get' for 3rd-Party Ubuntu Software +.UE \c +\ - \f[B]omg! ubuntu!\f[R] .IP \[bu] 2 -How To Install Third-Party Linux Applications with -Deb-Get (https://www.tomshardware.com/uk/how-to/install-linux-apps-with-deb-get) -- \f[B]toms HARDWARE\f[R] +\c +.UR +https://www.tomshardware.com/uk/how-to/install-linux-apps-with-deb-get +How To Install Third-Party Linux Applications with Deb-Get +.UE \c +\ - \f[B]toms HARDWARE\f[R] .IP \[bu] 2 -How to use deb-get to install third-party software on -Ubuntu (https://www.techrepublic.com/article/use-deb-get-install-third-party-software-ubuntu/) -- \f[B]TechRepublic\f[R] +\c +.UR +https://www.techrepublic.com/article/use-deb-get-install-third-party-software-ubuntu/ +How to use deb-get to install third-party software on Ubuntu +.UE \c +\ - \f[B]TechRepublic\f[R] .IP \[bu] 2 +\c +.UR https://news.itsfoss.com/deb-get-ubuntu/ Ubuntu MATE\[cq]s Lead Creates a Nifty Tool to Help Install 3rd Party -Deb Packages (https://news.itsfoss.com/deb-get-ubuntu/) - \f[B]It\[cq]s -FOSS\f[R] +Deb Packages +.UE \c +\ - \f[B]It\[cq]s FOSS\f[R] .IP \[bu] 2 -Easily Get 3rd-Party Software on Ubuntu With -Deb-Get (https://fosspost.org/deb-get-install-3rd-party-software-ubuntu/) -- \f[B]FOSS Post\f[R] +\c +.UR https://fosspost.org/deb-get-install-3rd-party-software-ubuntu/ +Easily Get 3rd-Party Software on Ubuntu With Deb-Get +.UE \c +\ - \f[B]FOSS Post\f[R] .IP \[bu] 2 -deb-get, an \[lq]apt-get\[rq] to install third-party software on -Ubuntu (https://ubunlog.com/en/deb-get-un-apt-get-para-instalar-software-de-terceros-en-ubuntu/) -- \f[B]ubunlog\f[R] +\c +.UR +https://ubunlog.com/en/deb-get-un-apt-get-para-instalar-software-de-terceros-en-ubuntu/ +deb-get, an \[lq]apt-get\[rq] to install third-party software on Ubuntu +.UE \c +\ - \f[B]ubunlog\f[R] .IP \[bu] 2 -deb-get, a utility for installing third-party -software (https://www.linuxadictos.com/en/deb-get-una-utilidad-para-instalar-software-de-terceros.html) -- \f[B]Linux Addicted\f[R] +\c +.UR +https://www.linuxadictos.com/en/deb-get-una-utilidad-para-instalar-software-de-terceros.html +deb-get, a utility for installing third-party software +.UE \c +\ - \f[B]Linux Addicted\f[R] .SH BUGS -.PP -Submit bug reports online at: - +Submit bug reports online at: \c +.UR https://github.com/wimpysworld/deb-get/issues +.UE \c .SH SEE ALSO -.PP -Full sources at: +Full sources at: \c +.UR https://github.com/wimpysworld/deb-get +.UE \c .PP deborah(1) .SH AUTHORS