summaryrefslogtreecommitdiffhomepage
path: root/modules/luci-base/luasrc/model/ipkg.luadoc
blob: 0dbab7a68fdeb5c329bc5e48673473e1d67fa4ed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
---[[
LuCI OPKG call abstraction library

module "luci.model.ipkg"
]]

---[[
Return information about installed and available packages.

@class function
@name info
@param pkg Limit output to a (set of) packages
@return Table containing package information
]]

---[[
Return the package status of one or more packages.

@class function
@name status
@param pkg Limit output to a (set of) packages
@return Table containing package status information
]]

---[[
Install one or more packages.

@class function
@name install
@param ... List of packages to install
@return Boolean indicating the status of the action
@return OPKG return code, STDOUT and STDERR
]]

---[[
Determine whether a given package is installed.

@class function
@name installed
@param pkg Package
@return Boolean
]]

---[[
Remove one or more packages.

@class function
@name remove
@param ... List of packages to install
@return Boolean indicating the status of the action
@return OPKG return code, STDOUT and STDERR
]]

---[[
Update package lists.

@class function
@name update
@return Boolean indicating the status of the action
@return OPKG return code, STDOUT and STDERR
]]

---[[
Upgrades all installed packages.

@class function
@name upgrade
@return Boolean indicating the status of the action
@return OPKG return code, STDOUT and STDERR
]]

---[[
List all packages known to opkg.

@class function
@name list_all
@param pat	Only find packages matching this pattern, nil lists all packages
@param cb	Callback function invoked for each package, receives name, version and description as arguments
@return	nothing
]]

---[[
List installed packages.

@class function
@name list_installed
@param pat	Only find packages matching this pattern, nil lists all packages
@param cb	Callback function invoked for each package, receives name, version and description as arguments
@return	nothing
]]

---[[
Find packages that match the given pattern.

@class function
@name find
@param pat	Find packages whose names or descriptions match this pattern, nil results in zero results
@param cb	Callback function invoked for each patckage, receives name, version and description as arguments
@return	nothing
]]

---[[
Determines the overlay root used by opkg.

@class function
@name overlay_root
@return		String containing the directory path of the overlay root.
]]

---[[
lua version of opkg compare-versions

@class function
@name compare_versions
@param ver1	string version 1
@param ver2	string version 2
@param comp	string compare versions using
		"<=" or "<" lower-equal
		">" or ">=" greater-equal
		"=" equal
		"<<" lower
		">>" greater
		"~=" not equal
@return Boolean indicating the status of the compare
]]