modules/luci-base/luasrc/model/ipkg.luadoc

   1 ---[[
   2 LuCI OPKG call abstraction library
   3
   4 module "luci.model.ipkg"
   5 ]]
   6
   7 ---[[
   8 Return information about installed and available packages.
   9
  10 @class function
  11 @name info
  12 @param pkg Limit output to a (set of) packages
  13 @return Table containing package information
  14 ]]
  15
  16 ---[[
  17 Return the package status of one or more packages.
  18
  19 @class function
  20 @name status
  21 @param pkg Limit output to a (set of) packages
  22 @return Table containing package status information
  23 ]]
  24
  25 ---[[
  26 Install one or more packages.
  27
  28 @class function
  29 @name install
  30 @param ... List of packages to install
  31 @return Boolean indicating the status of the action
  32 @return OPKG return code, STDOUT and STDERR
  33 ]]
  34
  35 ---[[
  36 Determine whether a given package is installed.
  37
  38 @class function
  39 @name installed
  40 @param pkg Package
  41 @return Boolean
  42 ]]
  43
  44 ---[[
  45 Remove one or more packages.
  46
  47 @class function
  48 @name remove
  49 @param ... List of packages to install
  50 @return Boolean indicating the status of the action
  51 @return OPKG return code, STDOUT and STDERR
  52 ]]
  53
  54 ---[[
  55 Update package lists.
  56
  57 @class function
  58 @name update
  59 @return Boolean indicating the status of the action
  60 @return OPKG return code, STDOUT and STDERR
  61 ]]
  62
  63 ---[[
  64 Upgrades all installed packages.
  65
  66 @class function
  67 @name upgrade
  68 @return Boolean indicating the status of the action
  69 @return OPKG return code, STDOUT and STDERR
  70 ]]
  71
  72 ---[[
  73 List all packages known to opkg.
  74
  75 @class function
  76 @name list_all
  77 @param pat      Only find packages matching this pattern, nil lists all packages
  78 @param cb       Callback function invoked for each package, receives name, version and description as arguments
  79 @return nothing
  80 ]]
  81
  82 ---[[
  83 List installed packages.
  84
  85 @class function
  86 @name list_installed
  87 @param pat      Only find packages matching this pattern, nil lists all packages
  88 @param cb       Callback function invoked for each package, receives name, version and description as arguments
  89 @return nothing
  90 ]]
  91
  92 ---[[
  93 Find packages that match the given pattern.
  94
  95 @class function
  96 @name find
  97 @param pat      Find packages whose names or descriptions match this pattern, nil results in zero results
  98 @param cb       Callback function invoked for each patckage, receives name, version and description as arguments
  99 @return nothing
 100 ]]
 101
 102 ---[[
 103 Determines the overlay root used by opkg.
 104
 105 @class function
 106 @name overlay_root
 107 @return         String containing the directory path of the overlay root.
 108 ]]
 109