android刷机脚本update-script常用语法说明

update-script脚本语法说明(根据android源代码中的recovery.c进行的定义):

文章来自各位网页发贴从中获取，非常感谢!

http://hi.baidu.com/mogoyu/blog/item/4c1f292a21bfda8d033bf6b1.html

http://www.deepin.org/thread-2120653-1-1.html

1.copy_dir

语法：copy_dir <src-dir> <dst-dir> [<timestamp>]

<src-dir>表示原文件夹，<dst-dir>表示目的文件夹，[<timestamp>]表示时间戳

作用：将<src-dir>文件夹中的内容复制到<dst-dir>文件夹中。<dst-dir>文件夹中的原始内容将会保存不变，除非<src-dir>文件夹中有相同的内容，这样<dst-dir>中的内容将被覆盖

举例：copy_dir PACKAGE:system SYSTEM:（将升级包中的system文件夹复制到手机中）

2.format

语法：format <root>

<root>表示要格式化的分区

作用：格式化一个分区

举例：format SYSTEM:（将手机/system分区完全格式化）

注意：格式化之后的数据是不可以恢复的

3.delete

语法：delete <file1> [... <fileN>]

<file1> [... <fileN>]表示要格式化的文件，可以是多个文件用空格隔开

作用：删除文件1，2到n

举例：delete SYSTEM:app/Calculator.apk（删除手机systen文件夹中app中的Calculator.apk文件）

4.delete_recursive

语法：delete_recursive <file-or-dir1> [... <file-or-dirN>]

<file-or-dir1> [... <file-or-dirN>]表示要删除的文件或文件夹，可以使多个，中间用空格隔开

作用：删除文件或者目录，删除目录时会将目录中的所有内容全部删除

举例：delete_recursive DATA:dalvik-cache（删除/data/dalvik-cache文件夹下的所有内容）

5.run_program

语法：run_program <program-file> [<args> ...]

<program-file>表示要运行的程序，[<args> ...]表示运行程序所加的参数

作用：运行终端程序

举例：run_program PACKAGE:install_busybox.sh（执行升级包中的install_busybox.sh脚本）

6.set_perm

语法：set_perm <uid> <gid> <mode> <path> [... <pathN>]

<uid>表示用户名称，<gid>表示用户组名称，<mode>，表示权限模式，<path> [... <pathN>]表示文件路径，可以使多个，用空格隔开

作用：设置单个文件或目录的所有者和权限，像linux中的chmod、chown或chgrp命令一样，只是集中在了一个命令当中

举例：set_perm 0 2000 0550 SYSTEM:etc/init.goldfish.sh（设置手机system中的etc/init.goldfish.sh的用户为root，用户组为shell，所有者以及所属用户组成员可以进行读取和执行操作，其他用户无操作权限）

7.set_perm_recursive

语法：set_perm_recursive <uid> <gid> <dir-mode> <file-mode> <path> [... <pathN>]

<uid>表示用户，<gid>表示用户组，<dir-mode>表示文件夹的权限，<file-mode>表示文件的权限，<path> [... <pathN>]表示文件夹的路径，可以多个，用空格分开

作用：设置文件夹及文件夹中的文件的所有者和用户组

举例：set_perm_recursive 0 0 0755 0644 SYSTEM:app（设置手机system/app文件夹及其中文件的用户为root，用户组为root，app文件夹权限为所有者可以进行读、写、执行操作，其他用户可以进行读取和执行操作，其中的文件的权限为所有者可以进行读写操作，其他用户可以进行读取操作）

8.show_progress

语法：show_progress <fraction> <duration>

<表示一个小部分> <表示一个小部分的持续时间>

作用：为下面进行的程序操作显示进度条，进度条会根据<duration>进行前进，当操作时间是确定的时候会更快

举例：show_progress 0.1 0（显示进度条当操作完成后前进10%）

9.symlink

语法：symlink <link-target> <link-path>

<link-target>表示链接到的目标，<link-path>表示快捷方式的路径

作用：相当于linux中的ln命令，将<link-target>在<link-path>处创建一个软链接，<link-target>的格式应为绝对路径（或许相对路径也可以），<link-path>为“根目录：路径”的形式

举例：symlink /system/bin/su SYSTEM:xbin/su（在手机中system中的xbin中建立一个/system/bin/su的快捷方式）

10.assert <boolexpr>

作用：此命令用来判断表达式boolexpr的正确与否，当表达式错误时程序终止执行

※此作用有待验证

11.write_radio_image <src-image>

作用：将基带部分的镜像写入手机，<src-image>表示镜像文件

举例：write_radio_image PACKAGE:radio.img

12.write_hboot_image <src-image>

作用：将系统bootloader镜像写入手机，<src-image>表示镜像位置，此命令在直到在所有的程序安装结束之后才会起作用

举例：write_hboot_image PACKAGE:hboot.img

13.write_raw_image <src-image> <dest-root>

作用：将boot.img写入手机，里面包含了内核和ram盘

举例：write_raw_image PACKAGE:boot.img BOOT:

14.  mount(fs_type, partition_type, location, mount_point)

参数详解: fs_type-----------------"yaffs2" 或 "ext4"

partition_type----------"MTD" 或 "EMMC"

location-----------------分区(partition) 或 驱动器(device)

mount_poin------------挂载文件系统的目标文件夹(target folder to mount FS)

作用解释: 挂载一个文件系统到指定的挂载点

返 回 值: 挂载成功则返回挂载点，失败返回null

函数示例: mount("MTD", "system", "/system");挂载system分区，设置返回指针"/system”

        mount("vfat", "/dev/block/mmcblk1p2", "/system"); 挂载/dev/block/mmcblk1p2，返回指针"/system”

15. is_mounted(mount_point)

参数详解: mount_point-----------字符串，检查是否已经挂载的挂载点

作用解释: 检查文件系统是否挂载

返 回 值: 挂载成功则返回挂载点，失败返回null

16.unmount(mount_point)

参数详解: mount_point-----------字符串，要解除挂载的挂载点

作用解释: 解除文件系统挂载

返 回 值: 解除挂载成功则返回挂载点，失败返回null

函数示例: unmount("/system"); 卸载/system分区

17.  set_progress

函数语法: set_prograss(frac)

参数详解: frac---------------------进度数值

18. package_extract_dir(package_path, destination_path)

参数详解: package_path----------字符串，升级包内要提取的目录

        destination_path--------字符串，提取文件的目标目录

作用解释: 提取升级包内目录中的所有文件到指定的目标目录

函数示例: package_extract_dir("system", "/system");释放ROM包里system文件夹下所有文件和子文件夹至/system

19. package_extract_file(package_path) 或 package_extract_file(package_path, destination_path)

参数详解: package_path----------字符串，升级包内要提取的文件

destination_path-------字符串，提取文件的目标目录

作用解释: 提取升级包内的单个文件到指定的目标目录

函数示例: package_extract_file("my.zip", "/system");解压ROM包里的my.zip文件至/system

20. file_getprop(file, key)

参数详解: file----------------------字符串，要检查的文件名

        Key----------------------字符串，返回数据中的文件的键名字

作用解释: 在格式"key"="value"的文件中取得文件属性值

21.getprop(key)

参数详解: key---------------------字符串，想要系统返回的属性

作用解释: 这个函数是用来返指定的属性的值。它是用来从build.props文件中查询手机的信息的。

22. apply_patch(srcfile, tgtfile, tgtsha1, tgtsize, sha1_1, patch_1, ..., sha1_x, patch1_x)

参数详解: srcfile-------------------字符串，要打补丁的源文件(要读入的文件)

        Tgtfile-------------------字符串，补丁文件要写入的目标文件

        tgtsha1-----------------字符串，写入补丁文件的目标文件的sha1哈希值

sha1_x------------------字符串，要写入目标文件的补丁数据的sha1哈希值 patch1_x----------------字符串，实际上应用到目标文件的补丁

作用解释: 这个函数是用来打补丁到文件。

23. apply_patch_check(file, sha1_1, ..., sha1_x)

参数详解: file----------------------字符串，要检查的文件

        sha1_x------------------要检查的哈希值

作用解释: 检查文件是否已经被打补丁，或者能不能被打补丁。需要检查“applypatch_check ”函数调用的源代码。

24. apply_patch_space(bytes)

参数详解: bytes-------------------检查的字节的数字

作用解释: 检查缓存来确定是否有足够的空间来写入补丁文件并返回一些数据。

25. read_file(filename)

参数详解: filename----------------字符串，要读取内容的文件名

作用解释: 这个函数返回文件的内容

26. sha1_check(data) 或 sha1_check(data, sha1_hex, ..., sha1_hexN)

参数详解: data---------------------要计算sha1哈希值的文件的内容-必须是只读文件格式

        sha1_hexN--------------文件数据要匹配的特定的十六进制sha1_hex哈希值字符串

作用解释: 如果只指定data参数，这个函数返回data参数的十六进制sha1_hex哈希值字符串。其他参数用来确认你检查的文件是不是列表中的哈希值的一个。 它返回匹配的哈希值，或者在没有匹配任何哈希值时返回空。 

27. ui_print(msg1, ..., msgN)

参数详解: msg----------------------字符串，要处理过程中输出给用户的信息

作用解释: 在脚本运行的时候，在控制台显示的信息。最少要指定1个参数，你可以指定额外的msg参数，并且它们会连接起来输了

函数示例: ui_print("It's ready!");屏幕打印It's ready!

28.  ifelse(condition, truecondition, falsecondition)

参数详解: condition----------------要运算的表达式

        Truecondition-----------当值为True时执行的 Edify脚本块

        Falsecodnition-----------当值为False时执行的 Edify脚本块

作用解释: 这是If-then结构的 Edify脚本语言。在真条件或非条件下语句可以是单条Edify命令或者脚本块。脚本块可以用圆括号来界定，用分号来隔开。

29. abort()

参数详解: 没有参数

作用解释: 中止脚本执行

30. assert(condition)

参数详解: condition---------------boolean

作用解释: 如果condition参数的计算结果为False，则停止脚本执行，否则继续执行脚本

函数示例: assert(package_extract_file("boot.img","/tmp/boot.img"),write_raw_image("/tmp/boot.img","boot"),delete("/tmp/boot.img"))

执行package_extract_file，如果不返回错误则执行write_raw_image，如果write_raw_image不出错则执行delete