From a0a5306174160ff412b0de95b60b21c06487e14e Mon Sep 17 00:00:00 2001 From: Dimitris Zlatanidis Date: Mon, 1 Jun 2015 06:23:27 +0300 Subject: [PATCH] update arguments comments --- README.rst | 105 +++++++++++++++++++++++++++----------- man/slpkg.8 | 124 ++++++++++++++++----------------------------- slpkg/arguments.py | 5 +- 3 files changed, 122 insertions(+), 112 deletions(-) diff --git a/README.rst b/README.rst index e4e84c9d..448fe9d4 100644 --- a/README.rst +++ b/README.rst @@ -309,39 +309,86 @@ Command Line Tool Usage ----------------------- .. code-block:: bash - + Slpkg is a user-friendly package manager for Slackware installations - + _ _ + ___| |_ __ | | ____ _ + / __| | '_ \| |/ / _` | + \__ \ | |_) | < (_| | + |___/_| .__/|_|\_\__, | + |_| |___/ + Commands: - update update all package lists - upgrade upgrade all package lists - repo-add [repository name] [URL] add custom repository - repo-remove [repository] remove custom repository - repo-list list all repositories - repo-info [repository] repository information - update slpkg check and update slpkg + update Run this command to update all + the packages list. + upgrade Delete and recreate all packages + lists. + repo-add [repository name] [URL] Add custom repository. + repo-remove [repository] Remove custom repository. + repo-list Print a list of all the + repositories. + repo-info [repository] Get information about a + repository. + update slpkg Upgrade the program directly from + repository. Optional arguments: - -h, --help show this help message and exit - -v, --version print version and exit - -a, [script.tar.gz] [source...] auto build SBo packages - -b, list, [package...] --add, --remove add, remove packages in blacklist - -q, list, [package...] --add, --remove add, remove SBo packages in queue - -q, build, install, build-install build, install packages from queue - -g, config, config=[editor] configuration file management - -l, [repository], --index, --installed list of repositories packages - -c, [repository] --upgrade check for updated packages - -s, [repository] [package...] download, build & install packages - -t, [repository] [package] package tracking dependencies - -p, [repository] [package], --color=[] print package description - -n, [package] view SBo site package in terminal - -F, [package...] find packages from repositories - -f, [package...] find installed packages - -i, [package...] install binary packages - -u, [package...] upgrade binary packages - -o, [package...] reinstall binary packages - -r, [package...] remove binary packages - -d, [package...] display the package contents + -h, --help Print this help message and exit + -v, --version Print program version and exit. + -a, [script.tar.gz] [source...] Auto build SBo packages. + If you already have downloaded the + script and the source code you can + build a new package with this + command. + -b, [package...] --add, --remove Manage packages in the blacklist. + list Add or remove packages and print + the list. Each package is added + here will not be accessible by the + program. + -q, [package...] --add, --remove Manage SBo packages in the queue. + list, build, install, build-install Add or remove and print the list + of packages. Build and then install + the packages from the queue. + -g, config, config=[editor] Configuration file management. + Print the configuration file or + edit. + -l, [repository], --index, --installed List of repositories packages. + Print a list of all available + packages repository, index or print + only packages installed on the + system. + -c, [repository] --upgrade Check and print of available + packages for upgrade. + -s, [repository] [package...] Sync packages. Install packages + directly from remote repositories + with all dependencies. + -t, [repository] [package] Track package dependencies and + print package dependenies tree with + highlight if packages is installed. + -p, [repository] [package], --color=[] Print description of a package + directly from the repository and + change color text. + -n, [package] View a standard of SBo page in + terminal and manage multiple options + like reading, downloading, building + installation, etc. + -F, [package...] Find packages from repositories and + search at each enabled repository + and prints results. + -f, [package...] Find and print installed packages + reporting the size and the sum. + -i, [package...] Installs single or multiple + Slackware binary packages (*.t?z). + -u, [package...] Upgrade single or multiple Slackware + binary packages from a older to a + newer one. + -o, [package...] Reinstall signle or multiple + Slackware binary packages with the + same packages if the exact. + -r, [package...] Removes a previously installed + Slackware binary packages. + -d, [package...] Display the packages contents and + file list. Slpkg Examples -------------- diff --git a/man/slpkg.8 b/man/slpkg.8 index ad7273a9..e7c26925 100644 --- a/man/slpkg.8 +++ b/man/slpkg.8 @@ -40,87 +40,7 @@ removes packages on Slackware based systems. It automatically computes dependencies and figures out what things should occurto install packages. Slpkg makes it easier to maintain groups of machines without having to manually update. -.PP -It's a quick and easy way to manage your packages in slackware to a command. -.SH EXAMPLES -Slpkg is a user-friendly package manager for Slackware installations -Commands: - update update all package lists - upgrade upgrade all package lists - repo-add [repository name] [URL] add custom repository - repo-remove [repository] remove custom repository - repo-list list all repositories - repo-info [repository] repository information - update slpkg check and update slpkg - -Optional arguments: - -h, --help show this help message and exit - -v, --version print version and exit - -a, [script.tar.gz] [source...] auto build SBo packages - -b, list, [package...] --add, --remove add, remove packages in blacklist - -q, list, [package...] --add, --remove add, remove SBo packages in queue - -q, build, install, build-install build, install packages from queue - -g, config, config= configuration file management - -l, [repository], --index, --installed list of repositories packages - -c, [repository] --upgrade check for updated packages - -s, [repository] [package...] download, build & install packages - -t, [repository] [package] package tracking dependencies - -p, [repository] [package], --color=[] print package description - -n, [package] view SBo site package in terminal - -f, [package...] find installed packages - -F, [package...] find packages from repositories - -i, [package...] install binary packages - -u, [package...] upgrade binary packages - -o, [package...] reinstall binary packages - -r, [package...] remove binary packages - -d, [package...] display the package contents - - -.SH PACKAGE FILE -Instead of [package...] you can create file with the suffix '.pkg' which was to -contain the packages you want to work like: - - # echo "brasero - > bitfighter - > ffmpeg" > foo.pkg - - # cat foo.pkg - > brasero - > bitfighter - > ffmpeg - - Example: - - # slpkg -s sbo foo.pkg - - or - - # slpkg -r foo.pkg - -.SH DEFAULT REPOSITORIES - slackware.com = 'slack' - SlackBuilds.org = 'sbo' - Alien's = 'alien' - slacky.eu = 'slacky' - rworkman's = 'rlw' - studioware.org = 'studio' - slacker.it = 'slackr' - slackonly.com = 'slonly' - Alien's ktown = 'ktown{latest}' - Alien's multilib = 'multi' - Slacke E17 and E18 = 'slacke{18}' - SalixOS = 'salix' - Slackel.gr = 'slackel' - Alien's restricted = 'rested' - - Default enable repository is 'slack' and 'sbo'. - Add or remove default repository in configuration file '/etc/slpkg/slpkg.conf'. - Read REPOSITORIES file for explanations. - -.SH COLORS - red, green, yellow, cyan, grey -.PP .SH GLOBAL OPTIONS .TP \fB\-v\fP, \fB\-\-version\fP @@ -288,6 +208,50 @@ command. For example: \fBslpkg \-\-help\fP - display help for slpkg +.SH DEFAULT REPOSITORIES + slackware.com = 'slack' + SlackBuilds.org = 'sbo' + Alien's = 'alien' + slacky.eu = 'slacky' + rworkman's = 'rlw' + studioware.org = 'studio' + slacker.it = 'slackr' + slackonly.com = 'slonly' + Alien's ktown = 'ktown{latest}' + Alien's multilib = 'multi' + Slacke E17 and E18 = 'slacke{18}' + SalixOS = 'salix' + Slackel.gr = 'slackel' + Alien's restricted = 'rested' + + Default enable repository is 'slack' and 'sbo'. + Add or remove default repository in configuration file '/etc/slpkg/slpkg.conf'. + Read REPOSITORIES file for explanations. + +.SH PACKAGE FILE +Instead of [package...] you can create file with the suffix '.pkg' which was to +contain the packages you want to work like: + + # echo "brasero + > bitfighter + > ffmpeg" > foo.pkg + + # cat foo.pkg + > brasero + > bitfighter + > ffmpeg + + Example: + + # slpkg -s sbo foo.pkg + + or + + # slpkg -r foo.pkg + +.SH COLORS + red, green, yellow, cyan, grey + .SH FILES /etc/slpkg/slpkg.conf General configuration of slpkg diff --git a/slpkg/arguments.py b/slpkg/arguments.py index b7bb2d40..12980923 100644 --- a/slpkg/arguments.py +++ b/slpkg/arguments.py @@ -33,7 +33,7 @@ def options(): / __| | '_ \| |/ / _` | \__ \ | |_) | < (_| | |___/_| .__/|_|\_\__, | - |_| |___/ + |_| |___/ Commands: update Run this command to update all @@ -92,8 +92,7 @@ Optional arguments: -F, [package...] Find packages from repositories and search at each enabled repository and prints results. - -f, [package...] Find installed packages. Print - installed packages matching, + -f, [package...] Find and print installed packages reporting the size and the sum. -i, [package...] Installs single or multiple Slackware binary packages (*.t?z).