diff --git a/doc/usage.md b/doc/usage.md index 0677436e..6e6e46b8 100644 --- a/doc/usage.md +++ b/doc/usage.md @@ -7,33 +7,41 @@ Tool, language and decoders for exploring binary data. For more information see https://github.com/wader/fq Usage: fq [OPTIONS] [--] [EXPR] [FILE...] ---compact,-c Compact output ---decode,-d=NAME Decode format (probe) ---file,-f=PATH Read EXPR from file ---formats Show supported formats ---help,-h Show help ---include-path,-L=PATH Include search path ---join-output,-j No newline between outputs ---null-input,-n Null input (can still use input/0 and inputs/0) ---null-output,-0 Null byte between outputs ---option,-o=KEY=VALUE,... Set option, eg: color=true - addrbase=16 - bitsformat=snippet - bytecolors=0-0xff=brightwhite,0=brightblack,32-126:9-13=white - color=false - colors=array=white,dumpaddr=yellow,dumpheader=yellow+underline,error=brightred,false=yellow,index=white,null=brightblack,number=cyan,object=white,objectkey=brightblue,string=green,true=yellow,value=white - decodeprogress=true - depth=0 - displaybytes=16 - linebytes=16 - raw=true - sizebase=10 - unicode=false - verbose=false ---raw-output,-r Raw string output (without quotes) ---repl,-i Interactive REPL ---slurp,-s Read (slurp) all inputs into an array ---version,-v Show version (dev) +--compact,-c Compact output +--decode,-d NAME Decode format (probe) +--file,-f PATH Read EXPR from file +--formats Show supported formats +--help,-h Show help +--include-path,-L PATH Include search path +--join-output,-j No newline between outputs +--null-input,-n Null input (can still use input/0 and inputs/0) +--null-output,-0 Null byte between outputs +--option,-o KEY=VALUE Set option, eg: color=true + addrbase=16 + bitsformat=snippet + bytecolors=0-0xff=brightwhite,0=brightblack,32-126:9-13=white + color=false + colors=array=white,dumpaddr=yellow,dumpheader=yellow+underline,error=brightred,false=yellow,index=white,null=brightblack,number=cyan,object=white,objectkey=brightblue,string=green,true=yellow,value=white + compact=false + decode_progress=true + depth=0 + displaybytes=16 + expr_file= + include_path= + join_string=\n + linebytes=16 + null_input=false + raw_output=true + raw_string=false + repl=false + sizebase=10 + slurp=false + unicode=false + verbose=false +--raw-output,-r Raw string output (without quotes) +--repl,-i Interactive REPL +--slurp,-s Read (slurp) all inputs into an array +--version,-v Show version (dev) - TODO: null input