Skip to content

GitLab

Last edited by Ameer Dawood
Page history

Usage

Basic Usage:

  1. Open terminal emulator
  2. Type su to obtain root
  3. Type onandroid
  4. Wait and watch
  • The behaviour of Online Nandroid can be adjusted by using command line flags, some of which are described in detail below. Each command line flag has its longer counter-part and both forms can be mixed. For a complete list of command line flags and short descriptions, type:
onandroid -h
OR
onandroid --help


Custom Backup Name:

  • Example:
onandroid -c NAME
OR
onandroid --custom NAME
  • Please be careful not to include characters not allowed in filenames. Spaces are not allowed.


Timezone modifier:

  • Example: Use phone timezone for backup file name
onandroid -p
OR
onandroid --phone
  • Example: Use UTC (default) for backup file name
onandroid -u
OR
onandroid --utc
  • Note: UTC is used as default (if no timezone modifier is passed). This is to comply with CWM nandroid backups.


Backup Modes:

Good old backup mode (default).
  • Example:
onandroid -o
OR
onandroid --old
  • Note: This is the most commonly known, default backup format.

Split backup mode (CWM6+ only).
  • Example:
onandroid -l
OR
onandroid --split
  • Note: This is specifically useful if you have partitions which are over 2GB in size. Use this only if you have CWM 6+.

CWM6 style incremental / dedupe backup mode.
  • Example:
onandroid -i
OR
onandroid --incremental

Garbage collect. For incremental backups (used for cleanup after deleting incremental backups).
  • Example:
onandroid -gc
OR
onandroid --garbagecollect

Advanced / Selective backup mode. For backing up only specific partitions.
  • Example:
onandroid -a PARTITIONS
OR
onandroid --advanced PARTITIONS
  • Partition letters / names can be found by typing onandroid -ah

TWRP backup mode.
  • Example:
onandroid -w
OR
onandroid --twrp
  • By default, TWRP backup mode creates uncompressed backups. If compressed backups are required, use it like this:
onandroid -w -ce
OR
onandroid --twrp --compression-enable
  • By default, TWRP backup mode generates md5sum. If md5sums are not required, use it like this:
onandroid -w -md
OR
onandroid --twrp --md5-disable


Replace Older Backups (with same name) - used with custom backup names:

  • While using custom backup names, Online Nandroid will not allow an already existing backup name to be specified, by default. Trying this will return an error and halt backup. If you want to replace the older backup with a new backup, by using the same custom backup name, specify the below command line flag.
  • Example:
onandroid -c MyBackup -r
OR
onandroid --custom MyBackup --replace
  • Note: This will only work with custom backup names. This can be used to update a backup from a previous state, by way of using advanced backup mode in combination with this mode.
  • Note: As of v9, replace mode would only replace the old backup after successful completion of the new backup. The old backup would be renamed to {backup_name}_old, where {backup_name} is the name of the backup. Once the new backup has completed, its files are moved to the old backup directory, the new backup directory is removed and the directory is renamed back to the backup name.