Skip to content

Module API Documentation

Michael Coppola edited this page Feb 23, 2014 · 1 revision

mkdir %destdir

Create directory %destdir.

cp %srcfile %destfile

Copy file from %srcfile to %destfile.

mv %src %dest

Move file or directory from %src to %dest.

rm %destfile

Delete file %destfile.

rmdir %destdir

Delete directory %destdir.

touch %destfile

Create file %destfile.

chmod %octalstr %dest

Set permissions of file or directory %dest to %octalstr.

For example, to apply the permissions rwxrwxrwx, the argument %octalstr would be "0777".

appendfile %srcfile %destfile

Append file %srcfile to %destfile.

appendtext %str %destfile

Append text %str to file %destfile. Command is binary-safe.

extract %srcfile %offset %size %destfile

Extract %size bytes at offset %offset from file %srcfile. Output to file %destfile.

freewrite %destfile %offset %str

Write string %str to file %destfile at offset %offset. Command is binary-safe.

pad %destfile %byte %size

Pad file %destfile with single byte %byte to size %size. If %size is less than %destfile file size, then exit with error.

bzip2-decomp %srcfile %destfile %srcfile

Decompress bzip2-compressed file %srcfile to %destfile

lzma-decomp %srcfile %destfile

Decompress LZMA-compressed file %srcfile to %destfile

unsquashfs-1.0 %srcfile %destdir

Unpack SquashFS filesystem %srcfile to %destdir. Utility version 1.0.

unsquashfs-1.3-lzma %srcfile %destdir

Unpack SquashFS filesystem (with LZMA compression) %srcfile to %destdir. Utility version 1.3.

unsquashfs-3.0-lzma %srcfile %destdir

Unpack SquashFS filesystem (with LZMA compression) %srcfile to %destdir. Utility version 3.0.

unsquashfs-4.1 %srcfile %destdir

Unpack SquashFS filesystem %srcfile to %destdir. Utility version 4.1.

cramfsck-2.x %srcfile %destdir

Unpack CramFS filesystem %srcfile to %destdir. Utility version 2.x.

mksquashfs-2.1 %srcdir %blocksize %endianness %destfile

Build SquashFS filesystem %destfile from directory %srcdir with block size %blocksize and endianness %endianness. Utility version 2.1.

%endianness may be one of the following values:

  • "le" = little endian
  • "be" = big endian

mksquashfs-2.1-lzma %srcdir %blocksize %endianness %destfile

Build SquashFS filesystem (with LZMA compression) %destfile from directory %srcdir with block size %blocksize and endianness %endianness. Utility version 2.1.

%endianness may be one of the following values:

  • "le" = little endian
  • "be" = big endian

mksquashfs-3.0-lzma %srcdir %blocksize %endianness %destfile

Build SquashFS filesystem (with LZMA compression) %destfile from directory %srcdir with block size %blocksize and endianness %endianness. Utility version 3.0.

%endianness may be one of the following values:

  • "le" = little endian
  • "be" = big endian

mksquashfs-3.2-r2-lzma %srcdir %blocksize %endianness %destfile

Build SquashFS filesystem (with LZMA compression) %destfile from directory %srcdir with block size %blocksize and endianness %endianness. Utility version 3.2-r2.

%endianness may be one of the following values:

  • "le" = little endian
  • "be" = big endian

mksquashfs-4.1-lzma %srcdir %blocksize %destfile

Build SquashFS filesystem (with LZMA compression) %destfile from directory %srcdir with block size %blocksize. Utility version 4.1.

mkcramfs-2.x %srcdir %edition %destfile

Build CramFS filesystem (edition %edition) %destfile from directory %srcdir.

belky-create %srckernel %srcfs %srcnvram %destfile

Create Belkin Extended Firmware Header image %destfile from kernel %srckernel, filesystem %srcfs, and NVRAM settings file %srcnvram.

belky-extract %srcfile %destkernel %destfs %destnvram

Extract Belkin Extended Firmware Header image %srcfile to kernel %destkernel, filesystem %destfs, and NVRAM settings file %destnvram.

unpfs %srcfile %destdir

Unpack PFS/0.9 archive %srcfile to %destdir.

packet %srcfile %bidfile %configfile

Generate a NETGEAR .chk header for file %srcfile with board ID in file %bidfile and config file %configfile. File %srcfile is modified in-place.

cvimg %srcfile %type %startaddr %burnaddr

Generate a Realtek header/footer for file %srcfile of type %type with start address %startaddr and burn address %burnaddr. File %srcfile is modified in-place.

%type may be one of the following values:

  • "root" = rootfs
  • "linux" = Linux kernel

mipsel-linux-strip %srcfile

Strip all symbols from MIPS object file %srcfile. This is most likely used for binary size minimization purposes.