github-personal/sysadm
1
0
Fork 0
mirror of https://github.com/outbackdingo/sysadm.git synced 2026-01-27 10:20:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Doc extra arguments to pkg_info.

Browse Source
This commit is contained in:
dlavigne
2016-03-28 14:08:53 -04:00
parent d68499f0e4
commit 842a594ce3
1 changed files with 11 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
api/classes/pkg.rst
View File

@@ -34,8 +34,17 @@ The rest of this section provides examples of the available *actions* for each t
Package Information
===================
The "pkg_info" action reads the pkg database directly and returns any relevant information. The "repo" is optional as it defaults to "local". The "pkg_origins" is also optional; if it is
not specified, information for all installed packages will be listed.
The "pkg_info" action reads the pkg database directly and returns any relevant information. The following arguments are optional:
* **"repo"**: unless specified, defaults to the local package repository.
* **"pkg_origins"**: unless specified, information for all installed packages will be listed.
* **"category"**: limits the results to packages within the specified category.
* **"result"**: may be set to anything other than "full" to restrict the information output to just the basic/simple information. This will not include sub-categories of information such as
"dependencies","requires","depends", or "options". For example, a request that specifies *{"action":"pkg_info","category":"x11","result":"simple"}* will result in a basic listing of all
the packages within the "x11" category.
**REST Request**