Skip to content

Latest commit

 

History

History
87 lines (81 loc) · 4.22 KB

command-line-interface.md

File metadata and controls

87 lines (81 loc) · 4.22 KB

Command-Line Interface

中文文档

Basic syntax

ampart ([nop 1] ([nop 1 arg]) [nop 2] ([nop 2 arg])...) [target] [parg 1] [parg 2]...

  • nop

    • means non-positional argument, nops can be written anywhere, if a nop has its required argument, that required argument must be right after that very nop.

  • target

    • means the target file/block device to operate on, it can either store DTB (plain DTB, Amlogic multi-DTB, or their gzipped versions), or the reserved partition, or the whole disk. By default ampart auto-recognize the target content, but you can hard-define it (see below)

  • parg

e.g. The following two commands are inter-changable

ampart --dry-run --mode dclone /dev/mmcblk0 data::-1:4
         ^nop1    ^nop2 ^nop2-arg ^target      ^parg1

ampart /dev/mmcblk0 data::-1:4 --mode dclone --dry-run 
         ^target      ^parg1    ^nop1 ^nop1-arg  ^nop2

But the following two commands are not

ampart --mode dclone /dev/mmcblk0 system::2G:2 data::-1:4
        ^nop1 ^nop1-arg ^target    ^parg1       ^parg2

ampart --mode dclone /dev/mmcblk0 data::-1:4 system::2G:2
        ^nop1 ^nop1-arg ^target    ^parg1     ^parg2

Non-positional arguments

All of the following arguments are listed in the --long-arg/-short-arg ([required argument]) style, you can use either form

  • --version/-v
    • Prints the version and early quit
  • --help/-h
    • Prints the help message and early quit
  • --mode/-m [mode name]
    • Set ampart to run in one of the following modes:
      • dtoe (DTB to EPT)
      • etod (EPT to DTB)
      • epedantic (is EPT pedantic)
      • dedit (DTB edit)
      • eedit (EPT edit)
      • dsnapshot (DTB snapshot)
      • esnapshot (EPT snapshot)
      • webreport (WEB report)
      • dclone (DTB clone)
      • eclone (EPT clone)
      • ecreate (EPT create)
    • Default: none, if no mode is set, ampart will not process the target
  • --content/-c [content type]
    • Set the content of the target
      • auto auto-identify target's content
      • dtb force ampart to treat target as DTB
      • reserved force ampart to treat target as reserved partition
      • disk force ampart to treat target as whole disk
    • Default: auto
  • --migrate/-M [migrate strategy]
    • Set the migrate strategy about partitions
      • none don't migrate any partition
      • essential only migrate essential partitions (reserved, env, misc, logo, etc)
      • all migrate all partitions
    • Default: essential
  • --strict-device/-s
    • If target is a block device, and --content is set, stick with that, and don't try to find the corresponding whole disk (If not set, and target is, e.g. /dev/reserved, ampart will find its underlying disk /dev/mmcblk0 and operate on that instead)
  • --dry-run/-d
    • Don't do any write
  • --offset-reserved/-R [offset of reserved partition in disk]
  • --offset-dtb/-D [offset of dtb in reserved partition]
  • --gap-partition/-p [gap between partitions]
  • --gap-reserved/-r [gap before reserved partition]

Standard Input/Output

stdin

ampart does not accept any input nor read anything from stdin (for now). This will potentially be used in the future for reading instructions piped in, but will never be used to read user input, as ampart is only intended to be called by scripts (and probabaly by some power-users)

stdout

ampart only generates snapshots on standard output in dsnapshot and esnapshot mode, or url in webreport mode, otherwise nothing is written to the standard output. 3 different snapshots will be guaranteed to be fed on standard output in the decimal>hex>human(decimal) order, one snapshot per line, scripts calling ampart can split the snapshots on \n character to get each snapshot, and split each snapshot on ' '(space, \x20) character to get each partition, then split each partition on : character to get name, offset, size and masks

stderr

Since standard output is used for snapshots only, all logs are printed to standard error