xref: /freebsd/contrib/file/src/file_opts.h (revision 898496ee09ed2b7d25f6807edc4515628196ec0a)

/*
 * Table of command-line options
 *
 * The first column specifies the short name, if any, or 0 if none.
 * The second column specifies the long name.
 * The third column specifies whether it takes a parameter.
 * The fourth column specifies whether is marked as "default"
 *      if POSIXLY_CORRECT is defined: 1,
 *      if POSIXLY_CORRECT is not defined: 2.
 * The fifth column is the documentation.
 *
 * N.B. The long options' order must correspond to the code in file.c,
 * and OPTSTRING must be kept up-to-date with the short options.
 * Pay particular attention to the numbers of long-only options in the
 * switch statement!
 */

OPT_LONGONLY("help", 0, 0,
    "                 display this help and exit\n", OPT_HELP)
OPT('v', "version", 0, 0,
    "              output version information and exit\n")
OPT('m', "magic-file", 1, 0,
    " LIST      use LIST as a colon-separated list of magic\n"
    "                               number files\n")
OPT('z', "uncompress", 0, 0,
    "           try to look inside compressed files\n")
OPT('Z', "uncompress-noreport", 0, 0,
    "  only print the contents of compressed files\n")
OPT('b', "brief", 0, 0,
    "                do not prepend filenames to output lines\n")
OPT('c', "checking-printout", 0, 0,
    "    print the parsed form of the magic file, use in\n"
    "                               conjunction with -m to debug a new magic file\n"
    "                               before installing it\n")
OPT('e', "exclude", 1, 0,
    " TEST         exclude TEST from the list of test to be\n"
    "                               performed for file. Valid tests are:\n"
    "                               %e\n")
OPT_LONGONLY("exclude-quiet", 1, 0,
    " TEST   like exclude, but ignore unknown tests\n", OPT_EXCLUDE_QUIET)
OPT('f', "files-from", 1, 0,
    " FILE      read the filenames to be examined from FILE\n")
OPT('F', "separator", 1, 0,
    " STRING     use string as separator instead of `:'\n")
OPT('i', "mime", 0, 0,
    "                 output MIME type strings (--mime-type and\n"
    "                               --mime-encoding)\n")
OPT_LONGONLY("apple", 0, 0,
    "                output the Apple CREATOR/TYPE\n", OPT_APPLE)
OPT_LONGONLY("extension", 0, 0,
    "            output a slash-separated list of extensions\n", OPT_EXTENSIONS)
OPT_LONGONLY("mime-type", 0, 0,
    "            output the MIME type\n", OPT_MIME_TYPE)
OPT_LONGONLY("mime-encoding", 0, 0,
    "        output the MIME encoding\n", OPT_MIME_ENCODING)
OPT('k', "keep-going", 0, 0,
    "           don't stop at the first match\n")
OPT('l', "list", 0, 0,
    "                 list magic strength\n")
#ifdef S_IFLNK
OPT('L', "dereference", 0, 1,
    "          follow symlinks (default if POSIXLY_CORRECT is set)")
OPT('h', "no-dereference", 0, 2,
    "       don't follow symlinks (default if POSIXLY_CORRECT is not set)")
#endif
OPT('n', "no-buffer", 0, 0,
    "            do not buffer output\n")
OPT('N', "no-pad", 0, 0,
    "               do not pad output\n")
OPT('0', "print0", 0, 0,
    "               terminate filenames with ASCII NUL\n")
#if defined(HAVE_UTIME) || defined(HAVE_UTIMES)
OPT('p', "preserve-date", 0, 0,
    "        preserve access times on files\n")
#endif
OPT('P', "parameter", 1, 0,
    "            set file engine parameter limits\n"
    "                               %P\n")
OPT('r', "raw", 0, 0,
    "                  don't translate unprintable chars to \\ooo\n")
OPT('s', "special-files", 0, 0,
    "        treat special (block/char devices) files as\n"
    "                             ordinary ones\n")
OPT('S', "no-sandbox", 0, 0,
    "           disable system call sandboxing\n")
OPT('C', "compile", 0, 0,
    "              compile file specified by -m\n")
OPT('d', "debug", 0, 0,
    "                print debugging messages\n")