Browse Source

Add README

Sven Velt 8 years ago
parent
commit
d5f26295d1
1 changed files with 46 additions and 0 deletions
  1. 46 0
      README

+ 46 - 0
README

@@ -0,0 +1,46 @@
+Ansible module for xbps package manager
+
+Install:
+
+  - put "xbps.py" into "library/" directory, next to your playbook/role
+
+
+Arguments:
+
+  + one of "name", "update_cache" and "upgrade" required,
+    but you can use up to all three at a time
+
+  - name: 
+    - name or list of packages
+    - "*" same as "upgrade=yes"
+
+  - update_cache: (yes|no), default: no
+    - sync remote repo index ("xbps-install -S")
+
+  - upgrade: (yes|no), default: no
+    - update/upgrade all installed packages ("xbps-install -u")
+
+  - state: (present|latest|absent), default: present
+    - state of "name" package(s)
+
+
+Example:
+
+  - ansible localhost -m xbps -a "name=screen"
+    installs "screen" package
+
+  - ansible localhost -m xbps -a "name=screen state=latest"
+    installs/updates "screen" package
+
+  - ansible localhost -m xbps -a "name=screen state=absent"
+    removes "screen" package
+
+  - ansible localhost -m xbps -a "update_cache=yes"
+    syncs remote repo index
+
+  - ansible localhost -m xbps -a "upgrade=yes"
+    upgrades all installed packages
+
+  - ansible localhost -m xbps -a "name=screen update_cache=yes upgrade=yes"
+    sync repo index, upgrades all installed packages and (maybe) installs screen
+