Skip to content

Latest commit

 

History

History
59 lines (56 loc) · 3.96 KB

Help-screen.md

File metadata and controls

59 lines (56 loc) · 3.96 KB
FreeArc'Next v0.11 (2016-10-06 by Bulat.Ziganshin@gmail.com)
Usage: fa COMMAND ARCHIVE [OPTION...] FILES/DIRS/@LISTFILES...

Commands:
  a[dd]|create     create archive from files/dirs
  l[ist]|lt        list files/solid blocks in the archive
  t[est]           check the archive integrity
  x|extract        extract all files from the archive

Options:
  -ag[FORMAT]  --autogenerate=[FORMAT]  append to archive name string generated by strftime(FORMAT||"%Y%m%d%H%M%S")
  -ao          --select-archive-bit     select only files with Archive bit set
  -bBYTES      --bufsize=BYTES          buffer size
  -cBYTES      --chunk=BYTES            average chunk size (default: 4kb)
  -cfgFILE     --config=FILE            use configuration FILE (default: fa.ini)
  -dpDIR       --diskpath=DIR           base DIR on disk
  -dsORDER     --sort=ORDER             sort files in the order defined by chars 'gerpnsd' ('gerpn' by default)
  -dup         --deduplication          global deduplication a-la ZPAQ
  -ed          --no-dirs                don't add empty dirs to archive
  -envVAR                               read default options from environment VAR (default: FA_CFG)
  -fEXPR       --filter=EXPR            filter files by Lua expression employing vars name, type, size, time and attr
  -kb          --keep-broken            keep extracted files that failed the CRC check
  -mMETHOD     --method=METHOD          set compression method
  -mcDIRECTIVE                          modify compressor: [$group1,$group2][:]-$group,-algo,+algo,algo1/algo2
  -miNUM       --io-threads=NUM         I/O threads
  -nFILESPECS  --include=FILESPECS      include only files matching FILESPECS
  -oMODE       --overwrite=MODE         existing files overwrite MODE (+/-/p)
  -r           --recursive              recursively find files to add (to do: or archives to list/extract)
  -rem...      --rem...                 remark (ignored commentary)
  -sGROUPING   --solid=GROUPING         group files into solid blocks
  -slBYTES     --max-size=BYTES         maximum filesize to process
  -slpMODE                              set large page mode (TRY(default), FORCE(+), DISABLE(-), MALLOC)
  -smBYTES     --min-size=BYTES         minimum filesize to process
  -t           --test                   test archive after operation
  -tNUM        --threads=NUM            worker threads (default: 8)
  -wDIRECTORY  --workdir=DIRECTORY      DIRECTORY for temporary files
  -xFILESPECS  --exclude=FILESPECS      exclude FILESPECS from operation
  -y           --answer-yes             answer Yes to all queries
               --cache=BYTES            size of read-ahead cache
               --crc-only               save/check CRC, but don't store data
               --dirs                   add empty dirs to archive
               --groups=FILE            name of groups file (arc.groups by default)
               --logfile=FILENAME       log file
               --min-chunk=BYTES        minimum chunk size (default: 48b)
               --no-check               don't check SHA-256 hashes of extracted data
               --no-data                don't write compressed data to the archive
               --no-dir                 don't write archive directory
               --no-read                only build list of files to compress
               --no-warnings            don't print warning messages to console
               --no-write               don't create archive file
               --prefetch[PARAMS]       prefetching to the OS file cache (:1g:8 means read 1GB ahead using 8 threads)
               --print-config           display built-in definitions of compression methods
               --profiler               print internal profiling stats
               --ratio=PERCENTS         automatically store blocks with order-0 entropy >PERCENTS% (99 by default)
               --save-sha-hashes        store in the archive SHA-256 hashes of the chunks

PLEASE DON'T USE THE PROGRAM IN PRODUCTION ENVIRONMENT SINCE THE ARCHIVE FORMAT IS NOT YET STABLE