mirror of
https://gitlab.com/dslackw/slpkg.git
synced 2024-11-17 07:48:18 +01:00
Updated for manpages
This commit is contained in:
Dimitris Zlatanidis
parent
b80f4e3c91
commit
d9fcbc3e64
3 changed files with 310 additions and 1 deletions
|
|
@ -7,7 +7,11 @@
|
|||
<option name="autoReloadType" value="SELECTIVE" />
|
||||
</component>
|
||||
<component name="ChangeListManager">
|
||||
<list default="true" id="122a51c9-ec79-4509-bab4-7ab1474a7769" name="Changes" comment="Updated for source" />
|
||||
<list default="true" id="122a51c9-ec79-4509-bab4-7ab1474a7769" name="Changes" comment="Updated for source">
|
||||
<change afterPath="$PROJECT_DIR$/docs/manpages/en.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/mkdocs.yml" beforeDir="false" afterPath="$PROJECT_DIR$/mkdocs.yml" afterDir="false" />
|
||||
</list>
|
||||
<option name="SHOW_DIALOG" value="false" />
|
||||
<option name="HIGHLIGHT_CONFLICTS" value="true" />
|
||||
<option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
|
||||
|
|
|
|||
303
docs/manpages/en.md
Normal file
303
docs/manpages/en.md
Normal file
|
|
@ -0,0 +1,303 @@
|
|||
# NAME
|
||||
|
||||
slpkg - Package manager utility for Slackware.
|
||||
|
||||
# SYNOPSIS
|
||||
|
||||
slpkg \[*COMMAND*\] \[*OPTIONS*\] \[*FILELIST\|PACKAGES\...*\]
|
||||
|
||||
slpkg \[-h\|-v\] \[-u, update\] \[-U, upgrade\] \[-c, check-updates\]
|
||||
\[-I, repo-info\] \[-g, configs\] \[-L, clean-logs\] \[-D, clean-tmp\]
|
||||
\[-T, clean-data\] \[-b, build\] \[-i, install\] \[-d, download\] \[-R,
|
||||
remove\] \[-f, find\] \[-w, view\] \[-s, search\] \[-e, dependees\]
|
||||
\[-t, tracking\] -y, \--yes, -j, \--jobs, -O, \--resolve-off, -r,
|
||||
\--reinstall, -k, \--skip-installed, -a, \--install-data, -E,
|
||||
\--full-reverse, -S, \--search, -n, \--no-silent, -p, \--pkg-version,
|
||||
-P, \--parallel, -o, \--repository=*NAME*, -z, \--directory=*PATH*
|
||||
|
||||
# DESCRIPTION
|
||||
|
||||
Slpkg is a software package manager that installs, updates, and removes
|
||||
packages on Slackware based systems. It automatically computes
|
||||
dependencies and figures out what things should occur to install
|
||||
packages. Slpkg makes it easier to maintain groups of machines without
|
||||
having to manually update.
|
||||
|
||||
Slpkg works in accordance with the standards of the organization
|
||||
SlackBuilds.org to build packages. Also uses the Slackware Linux
|
||||
instructions for installation, upgrading or removing packages.
|
||||
|
||||
# COMMANDS
|
||||
|
||||
**-u, update**
|
||||
|
||||
> Updates the package list and the database.
|
||||
|
||||
**-U, upgrade**
|
||||
|
||||
> Upgrade all the installed packages if the newer version exists in the
|
||||
> repository.
|
||||
|
||||
**-c, check-updates**
|
||||
|
||||
> Check if there is any news on the repositories ChangeLog.txt file.
|
||||
|
||||
**-I, repo-info**
|
||||
|
||||
> View information related to repositories, such as which repositories
|
||||
> are active, when they were upgraded, and how many packages they
|
||||
> contain.
|
||||
|
||||
**-L, clean-logs**
|
||||
|
||||
> Cleans dependencies log tracking. After that procedure you should
|
||||
> remove dependencies by hand.
|
||||
|
||||
**-T, clean-data**
|
||||
|
||||
> Sometimes is necessary to clean all the repositories data from the
|
||||
> database. Run this command to delete all the data and run \'*slpkg
|
||||
> update*\' to recreate.
|
||||
|
||||
**-D, clean-tmp**
|
||||
|
||||
> Deletes all the downloaded SlackBuilds scripts and sources.
|
||||
|
||||
**-g, configs**
|
||||
|
||||
> Edit the configuration /etc/slpkg/slpkg.toml file.
|
||||
|
||||
**-b, build**
|
||||
|
||||
> Builds the Slackbuilds scripts and add the packages to the \'/tmp\'
|
||||
> directory.
|
||||
|
||||
**-i, install**
|
||||
|
||||
> Builds and installs the packages in the correct order, and also logs
|
||||
> the packages with the dependencies for removal.
|
||||
|
||||
**-d, download**
|
||||
|
||||
> Download the current SlackBuilds scripts and the sources without
|
||||
> building or installing them.
|
||||
|
||||
**-R, remove**
|
||||
|
||||
> Removes packages with dependencies if the packages was installed with
|
||||
> \'*slpkg install*\' method. Slpkg looks at the \'REPO_TAG\'
|
||||
> configuration to find packages for removal by default, except if you
|
||||
> are using **\--file-pattern** option.
|
||||
|
||||
**-f, find**
|
||||
|
||||
> Find your installed packages on your system.
|
||||
|
||||
**-w, view**
|
||||
|
||||
> View information packages from the repository and get everything in
|
||||
> your terminal.
|
||||
|
||||
**-s, search**
|
||||
|
||||
> Search and match packages from the repository.
|
||||
|
||||
**-e, dependees**
|
||||
|
||||
> Show which SlackBuilds depend on.
|
||||
|
||||
**-t, tracking**
|
||||
|
||||
> Tracking the packages dependencies.
|
||||
|
||||
# OPTIONS
|
||||
|
||||
**-y, \--yes**
|
||||
|
||||
> Answer Yes to all questions. (to be used with: -u, update, -U,
|
||||
> upgrade, -b, build, -i, install, -R, remove, -d, download,)
|
||||
|
||||
**-j, \--jobs**
|
||||
|
||||
> Acceleration of SlackBuild scripts. When the **\--jobs** flag is set,
|
||||
> slpkg automatically detects the number of processors and enters it
|
||||
> into the MAKEFLAGS variable. Some SlackBuilds fail when MAKEFLAGS is
|
||||
> declared or the number of processors (-j) is greater than one. (to be
|
||||
> used with: -U, upgrade, -b, build, -i, install)
|
||||
|
||||
**-O, \--resolve-off**
|
||||
|
||||
> Turns off dependency resolving. (to be used with: -U, upgrade, -b,
|
||||
> build, -i, install)
|
||||
|
||||
**-r, \--reinstall**
|
||||
|
||||
> Use this option if you want to upgrade all packages even if the same
|
||||
> version is already installed. Do not skip installed packages. (to be
|
||||
> used with: -U, upgrade, -i, install)
|
||||
|
||||
**-k, \--skip-installed**
|
||||
|
||||
> This a helpful option if you want to avoid building and reinstalling
|
||||
> packages. Note: This option affects only the dependencies. (to be used
|
||||
> with: -i, install)
|
||||
|
||||
**-a, \--install-data**
|
||||
|
||||
> Install the data into the database only, if when you don\'t want to
|
||||
> re-download or re-synchronize the package lists, and you have already
|
||||
> downloaded the repository, you can apply this options to install the
|
||||
> data into the database. This is a helpful especially for locals
|
||||
> repositories and for those who download the repositories manually. (to
|
||||
> be used with: -u, update)
|
||||
|
||||
**-E, \--full-reverse**
|
||||
|
||||
> Full reverse dependency. Works only with -e, dependees command and
|
||||
> show the requires too. (to be used with: -e, dependees)
|
||||
|
||||
**-S, \--search**
|
||||
|
||||
> Enable the dialog utility to search packages from the repository.
|
||||
> Example try: \'*slpkg install python3 \--search*\' or \'*slpkg
|
||||
> download python3 \--search*\' and etc. (to be used with: -b, build,
|
||||
> -i, install, -d, download, -R, remove, -f, find, -w, view, -s, search,
|
||||
> -e, dependees, -t, tracking)
|
||||
|
||||
**-n, \--no-silent**
|
||||
|
||||
> Disable silent mode, if it is enabled in the configuration file. (to
|
||||
> be used with: -u, update, -U, upgrade, -b, build, -i, install, -R,
|
||||
> remove)
|
||||
|
||||
**-p, \--pkg-version**
|
||||
|
||||
> Print the repository package version. (to be used with: -e, dependees,
|
||||
> -t, tracking, -w, view)
|
||||
|
||||
**-P, \--parallel**
|
||||
|
||||
> Download files in parallel to speed up the process. (to be used with:
|
||||
> -u, update, -U, upgrade, -b, build, -i, install, -d, download)
|
||||
|
||||
**-m, \--no-case**
|
||||
|
||||
> Case-sensitive pattern matching packages. (to be used with: -b, build,
|
||||
> -i, install, -d, download, -s, search, -f, find, -w, view, -t,
|
||||
> tracking, -e, dependees)
|
||||
|
||||
**-o,**** \-\--repository=***NAME***\"**
|
||||
|
||||
> Switches the default repository and set the repository you want to
|
||||
> work with. Make sure that you have been enabling the repository in the
|
||||
> file \'/etc/slpkg/repositories.toml\'. Repo pattern \'\*\' supported
|
||||
> only with: \'-s, search\' option. (to be used with: -u, update, -U,
|
||||
> upgrade, -c, check-updates, -I, repo-info, -b, build, -i, install, -d,
|
||||
> download, -s, search, -t, tracking, -e, dependees, -w, view)
|
||||
|
||||
**-z,**** \--directory=***PATH***\"**
|
||||
|
||||
> The directory is the path where the files will be saved. (to be used
|
||||
> with: -d, download)
|
||||
|
||||
**-h \| \--help**
|
||||
|
||||
> Show help information and exit.
|
||||
|
||||
**-v \| \--version**
|
||||
|
||||
> Print version and exit.
|
||||
|
||||
# OPTION SYNTAX
|
||||
|
||||
Away from the classical way, you may put several options that do not
|
||||
require arguments together, like:
|
||||
|
||||
slpkg -iPny \[*PACKAGES\...*\]
|
||||
|
||||
# FILELIST\|PACKAGES
|
||||
|
||||
Instead of packages, you can pass a text file with suffix \'.pkgs\' and
|
||||
with the names of the packages. Example: \'*slpkg install list.pkgs*\'.
|
||||
Edit the config \'/etc/slpkg/slpkg.toml\' file to change the suffix if
|
||||
you want. You can use lists from others, like \'.sqf\' files.
|
||||
|
||||
# MUST YOU KNOW
|
||||
|
||||
There are five indicators when some commands are used, for example:
|
||||
|
||||
Cyan: To install, Yellow: To build, Grey: It\'s installed, Violet: For
|
||||
the upgrade, Red: To remove.
|
||||
|
||||
When you use the install, build, upgrade or remove commands you should
|
||||
know that, if the package is installed then its color will change to
|
||||
gray, if the package is upgradeable then it will change to violet, and
|
||||
if it is not installed then its color will be cyan. Also, if you try to
|
||||
remove a package you will see the package color turns red.
|
||||
|
||||
Example: If the package is already installed and the indicator color is
|
||||
grey and the option \'**-r, \--reinstall**\' is not applied, the package
|
||||
will skip from the installation and you will see a message \'(already
|
||||
installed)\'. If the package is upgradeable, the installation will
|
||||
continue and the package will go to upgrade.
|
||||
|
||||
For the upgrade command, you should know, that you can upgrade packages
|
||||
from different repositories, if you edit the
|
||||
\'*/etc/slpkg/repositories.toml*\' file and remove the repository tag.
|
||||
Then the slpkg can\'t recognize the repository of the packages.
|
||||
|
||||
With the remove command, it\'s going to remove the dependencies if the
|
||||
package had installed with the \'*slpkg install*\' command, otherwise,
|
||||
the slpkg does not know the dependencies that are installed with the
|
||||
packages that going to remove.
|
||||
|
||||
You can apply the asterisk \'\*\' instead of a package, to matching all
|
||||
the packages from a repository. You can\'t apply an asterisk to the
|
||||
\'**-o, \--repository=**\' option, except for the \'**-s, search**\',
|
||||
command.
|
||||
|
||||
Note: There is currently no function to indicate the packages if the
|
||||
colors are disabled.
|
||||
|
||||
# EXIT STATUS
|
||||
|
||||
0 Successful slpkg execution.
|
||||
|
||||
1 Something wrong happened.
|
||||
|
||||
20 No package found to be downloaded, installed, reinstalled, upgraded,
|
||||
or removed.
|
||||
|
||||
# EXPLANATION CHARACTERS
|
||||
|
||||
\[•\] Processing status: Red is still processing, Green is done.
|
||||
|
||||
\[✔️\] Done character: Appear when the processing is done.
|
||||
|
||||
\[X\] Failed character: Appear when the processing is failed.
|
||||
|
||||
\[↪\] Skipped character: Appear when the processing skipped.
|
||||
|
||||
# CONFIGURATION FILES
|
||||
|
||||
Configuration file in the /etc/slpkg/slpkg.toml file.
|
||||
|
||||
Repositories file in the /etc/slpkg/repositories.toml file.
|
||||
|
||||
Blacklist file in the /etc/slpkg/blacklist.toml file.
|
||||
|
||||
Rules file in the /etc/slpkg/rules.toml file.
|
||||
|
||||
*slpkg_new-configs* command it\'s managing the .new configuration files
|
||||
easily and fast. Move, copy or remove them.
|
||||
|
||||
# REPORT BUGS
|
||||
|
||||
Please report any found to: https://gitlab.com/dslackw/slpkg/-/issues.
|
||||
|
||||
Note: With the issue, please reference the log file you will find in the
|
||||
/tmp/slpkg/logs/slpkg.log path and paste it too.
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Dimitris Zlatanidis \<dslackw@gmail.com\>
|
||||
|
|
@ -14,6 +14,8 @@ nav:
|
|||
- How to start:
|
||||
- CLI Usage: 'cli_usage/index.md'
|
||||
- Examples: 'how_to_start/index.md'
|
||||
- Manpages:
|
||||
- EN: 'manpages/en.md'
|
||||
- Configuration:
|
||||
- Files: 'configuration/index.md'
|
||||
- Multilib: 'configuration/multilib.md'
|
||||
|
|
|
|||
Loading…
Reference in a new issue