Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fmt: move help strings to markdown file #4430

Merged
merged 1 commit into from
Feb 24, 2023

Conversation

jhowww
Copy link
Contributor

@jhowww jhowww commented Feb 24, 2023

#4368

fmt -h outputs the following.

$ ./target/debug/coreutils fmt -h
Reformat paragraphs from input files (or stdin) to stdout.

Usage: ./target/debug/coreutils fmt [OPTION]... [FILE]...

Arguments:
  [files]...  

Options:
  -c, --crown-margin          First and second line of paragraph may have different indentations, in which case the    
                              first line's indentation is preserved, and each subsequent line's indentation matches the
                              second line.
  -t, --tagged-paragraph      Like -c, except that the first and second line of a paragraph *must* have different      
                              indentation or they are treated as separate paragraphs.
  -m, --preserve-headers      Attempt to detect and preserve mail headers in the input. Be careful when combining this 
                              flag with -p.
  -s, --split-only            Split lines only, do not reflow.
  -u, --uniform-spacing       Insert exactly one space between words, and two between sentences. Sentence breaks in the
                              input are detected as [?!.] followed by two spaces or a newline; other punctuation is not
                              interpreted as a sentence break.
  -p, --prefix <PREFIX>       Reformat only lines beginning with PREFIX, reattaching PREFIX to reformatted lines.      
                              Unless -x is specified, leading whitespace will be ignored when matching PREFIX.
  -P, --skip-prefix <PSKIP>   Do not reformat lines beginning with PSKIP. Unless -X is specified, leading whitespace   
                              will be ignored when matching PSKIP
  -x, --exact-prefix          PREFIX must match at the beginning of the line with no preceding whitespace.
  -X, --exact-skip-prefix     PSKIP must match at the beginning of the line with no preceding whitespace.
  -w, --width <WIDTH>         Fill output lines up to a maximum of WIDTH columns, default 79.
  -g, --goal <GOAL>           Goal width, default ~0.94*WIDTH. Must be less than WIDTH.
  -q, --quick                 Break lines more quickly at the expense of a potentially more ragged appearance.
  -T, --tab-width <TABWIDTH>  Treat tabs as TABWIDTH spaces for determining line length, default 8. Note that this is  
                              used only for calculating line lengths; tabs are preserved in the output.
  -h, --help                  Print help information
  -V, --version               Print version information

@github-actions
Copy link

GNU testsuite comparison:

GNU test failed: tests/misc/timeout. tests/misc/timeout is passing on 'main'. Maybe you have to rebase?

@jhowww jhowww force-pushed the fmt-move-help-strings-to-md-file branch from 7b77a28 to 3640a90 Compare February 24, 2023 08:45
@sylvestre sylvestre merged commit ac0b261 into uutils:main Feb 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants