Skip to content

group command line args into affected processing steps #1814

@keithgabryelski

Description

@keithgabryelski

I suggest rg --help (and possibly the man page) group output of command line args.
I think sorted alphabetically is great as a default... but an option to see args for
only a certain processing setup (like those affecting input files searched or
those affecting the output format) would help ME narrow down where to look
for the command line arg I know exists but have just forgotten its name/mnemonic

here is MY suggestion (and, yes, I think only the names/mneumonics are needed
for sections like this -- the full description can be looked up in the alphabetical list).

OUTPUT FORMAT
    -0, --null                              
    -A, --after-context <NUM>               
    -B, --before-context <NUM>              
    -C, --context <NUM>                     
    -H, --with-filename                     
    -I, --no-filename                       
    -N, --no-line-number                    
    -b, --byte-offset                       
    -c, --count                             
    -l, --files-with-matches                
    -m, --max-count <NUM>                   
    -n, --line-number                       
    -o, --only-matching                     
    -r, --replace <REPLACEMENT_TEXT>        
        --color <WHEN>                      
        --colors <COLOR_SPEC>...            
        --column                            
        --context-separator <SEPARATOR>     
        --count-matches                     
        --files                             
        --heading                           
        --json                              
        --max-columns-preview               
        --no-heading                        
        --no-messages                       
        --null-data                         
        --passthru                          
        --sort <SORTBY>                     
        --sortr <SORTBY>                    
        --stats                             
        --trim                              
        --vimgrep                           

INPUT FILE SEARCHING
    -F, --fixed-strings                     
    -M, --max-columns <NUM>                 
    -P, --pcre2                             
    -S, --smart-case                        
    -U, --multiline                         
    -a, --text                              
    -e, --regexp <PATTERN>...               
    -i, --ignore-case                       
    -p, --pretty                            
    -q, --quiet                             
    -s, --case-sensitive                    
    -v, --invert-match                      
    -x, --line-regexp                       
    -z, --search-zip
        --binary                            
        --multiline-dotall                  
        --no-pcre2-unicode                  
        --no-unicode                        
        --pre <COMMAND>                     
        --pre-glob <GLOB>...                

INPUT FILES
    -L, --follow                            
    -T, --type-not <TYPE>...                
    -f, --file <PATTERNFILE>...             
    -g, --glob <GLOB>...                    
    -t, --type <TYPE>...                    
    -u, --unrestricted                      
    -w, --word-regexp                       
        --glob-case-insensitive             
        --hidden                            
        --iglob <GLOB>...                   
        --ignore-file <PATH>...             
        --ignore-file-case-insensitive      
        --max-depth <NUM>                   
        --max-filesize <NUM+SUFFIX?>        
        --no-ignore                         
        --no-ignore-dot                     
        --no-ignore-exclude                 
        --no-ignore-files                   
        --no-ignore-global                  
        --no-ignore-messages                
        --no-ignore-parent                  
        --no-ignore-vcs                     
        --no-require-git                    
        --one-file-system                   
        --type-add <TYPE_SPEC>...           
        --type-clear <TYPE>...              

OUTPUT FILE FILTERING
        --files-without-match               
        --include-zero                      

ENGINE
        --auto-hybrid-regex # deprecated
        --block-buffered                    
        --crlf                              
        --debug                             
        --dfa-size-limit <NUM+SUFFIX?>      
    -E, --encoding <ENCODING>               
        --engine <ENGINE>                   
    -h, --help                              
        --line-buffered                     
        --mmap                              
        --no-config                         
        --no-mmap                           
        --path-separator <SEPARATOR>        
        --pcre2-version                     
        --regex-size-limit <NUM+SUFFIX?>    
    -j, --threads <NUM>                     
        --type-list                         
    -V, --version                           



Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementAn enhancement to the functionality of the software.questionAn issue that is lacking clarity on one or more points.rollupA PR that has been merged with many others in a rollup.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions