summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorAaron Ball <nullspoon@oper.io>2018-06-10 11:10:14 -0600
committerAaron Ball <nullspoon@oper.io>2018-06-10 11:10:26 -0600
commit291c9085df013a2d5cd9b994efd4d6f3ffe6f0c5 (patch)
tree3d5389fbdaf36bbf6d1afa7a7ba8b42670a69fda /README.rst
parent4222f3ddc48da5e8fd14f9ed5051706a8ae8812f (diff)
downloadandbackup-291c9085df013a2d5cd9b994efd4d6f3ffe6f0c5.tar.gz
andbackup-291c9085df013a2d5cd9b994efd4d6f3ffe6f0c5.tar.xz
Converted docs to rst format
Split README into two docs: README.rst and TODO.rst. The todo file contains bugs and features (moved bugs section from old readme file into todo). README contains new documentation detailing what andbackup does, usage, and examples.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst43
1 files changed, 43 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..547aba4
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,43 @@
+======
+README
+======
+
+Andbackup is a basic Android application (or package) backup and restore
+script. It can backup a single application, or a list of applications provided
+in a text file (one application name per line). It can do the same for
+application restore.
+
+**NOTE**: The andbackup.sh script requires root to run.
+
+
+Usage
+=====
+
+::
+
+ sh andbackup.sh <action> [<application_name>] [<list_file>]
+
+
+Example Usage
+=============
+
+Perform bulk backup from application list in file *apps.txt*::
+
+ sh andbackup.sh listbackup apps.txt
+
+
+Backup a single app (K9 mail for this example)::
+
+ sh andbackup.sh backup com.fsck.k9
+
+
+Restore a single app (again, K9 mail in this example)::
+
+ sh andbackup.sh restore com.fsck.k9
+
+
+Perform bulk restore from application list in file *apps.txt*::
+
+ sh andbackup.sh listrestore apps.txt
+
+

Generated by cgit