diff options
Diffstat (limited to 'bin/gensquashfs/options.c')
| -rw-r--r-- | bin/gensquashfs/options.c | 58 |
1 files changed, 11 insertions, 47 deletions
diff --git a/bin/gensquashfs/options.c b/bin/gensquashfs/options.c index b554cb2..43ab057 100644 --- a/bin/gensquashfs/options.c +++ b/bin/gensquashfs/options.c @@ -65,9 +65,8 @@ static const char *help_string = " --pack-dir, -D <directory> If --pack-file is used, this is the root path\n" " relative to which to read files. If no pack\n" " file is specified, pack the contents of the\n" -" given directory into a SquashFS image. The\n" -" directory becomes the root of the file\n" -" system.\n" +" given directory. The directory becomes the\n" +" file system root.\n" "\n" " --compressor, -c <name> Select the compressor to use.\n" " A list of available compressors is below.\n" @@ -127,39 +126,16 @@ static const char *help_string = "\n"; const char *help_details = -"When using the pack file option, the given file is expected to contain\n" -"newline separated entries that describe the files to be included in the\n" -"SquashFS image. The following entry types can be specified:\n" +"Example of a pack file:\n" "\n" -"# a comment\n" -"file <path> <mode> <uid> <gid> [<location>]\n" -"dir <path> <mode> <uid> <gid>\n" -"nod <path> <mode> <uid> <gid> <dev_type> <maj> <min>\n" -"slink <path> <mode> <uid> <gid> <target>\n" -"link <path> <dummy> <dummy> <dummy> <target>\n" -"pipe <path> <mode> <uid> <gid>\n" -"sock <path> <mode> <uid> <gid>\n" -"glob <path> <mode|*> <uid|*> <gid|*> [OPTIONS...] <location>\n" -"\n" -"<path> Absolute path of the entry in the image. Can be put in quotes\n" -" if some components contain spaces.\n" -"<location> If given, location of the input file. Either absolute or relative\n" -" to the description file. If omitted, the image path is used,\n" -" relative to the description file.\n" -"<target> Symlink or hardlink target.\n" -"<mode> Mode/permissions of the entry.\n" -"<uid> Numeric user id.\n" -"<gid> Numeric group id.\n" -"<dev_type> Device type (b=block, c=character).\n" -"<maj> Major number of a device special file.\n" -"<min> Minor number of a device special file.\n" -"\n" -"Example:\n" " # A simple squashfs image\n" " dir /dev 0755 0 0\n" " nod /dev/console 0600 0 0 c 5 1\n" " dir /root 0700 0 0\n" -" dir /sbin 0755 0 0\n" +" \n" +" # `slink` for symlink, `link` for hard links\n" +" slink /lib 0777 0 0 /usr/lib\n" +" link /init 0777 0 0 /sbin/init\n" " \n" " # Add a file. Input is relative to listing or pack dir.\n" " file /sbin/init 0755 0 0 ../init/sbin/init\n" @@ -178,22 +154,10 @@ const char *help_details = "\n\n"; const char *sort_details = -"When using a sort file, the order in which regular files are packed can be\n" -"changed, as well as packing behaviour. Each line in the sort file consists\n" -"of a numeric priority (can be negative, lower priority is packed first),\n" -"followed by optional packing flags, followed by the file path.\n" -"\n" -"The fields are white-space separated. The flags are comma seperated and\n" -"contained within two square bracktes. Single line comments with `#` and\n" -"empty lines are allowed.\n" -"\n" -"The default priority for un-listed files is 0. The filename specifies the\n" -"path within the SquashFS image and is normalized. If e.g. spaces at the\n" -"beginning or end are needed, it can be enclosed in double quotes `\"`\n" -"and back-slash can be used for escaping.\n" -"\n" -"The sorting algorithm is stable, so files with the same priority do not\n" -"change place relative to each other in their initial ordering.\n" +"When using a sort file, the specified paths are within the SquashFS image.\n" +"Files with lower priority are packed first, default priority is 0.\n" +"The sorting is stable, files with the same priority do not change place\n" +"relative to each other.\n" "\n" "Example:\n" " # Specify a packing order with file globbing\n" |