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

ptx: move help strings to markdown file #4422

Merged
merged 2 commits into from
Mar 6, 2023

Conversation

chenchiii
Copy link
Contributor

#4368

ptx -h outputs the following.

$ ./target/debug/coreutils ptx -h
Output a permuted index, including context, of the words in the input files.
Mandatory arguments to long options are mandatory for short options too.
With no FILE, or when FILE is -, read standard input. Default is '-F /'.

Usage: ./target/debug/coreutils ptx [OPTION]... [INPUT]...  
./target/debug/coreutils ptx -G [OPTION]... [INPUT [OUTPUT]]

Options:
  -A, --auto-reference            output automatically generated references
  -G, --traditional               behave more like System V 'ptx'
  -F, --flag-truncation <STRING>  use STRING for flagging line truncations
  -M, --macro-name <STRING>       macro name to use instead of 'xx'
  -O, --format=roff               generate output as roff directives
  -R, --right-side-refs           put references at right, not counted in -w
  -S, --sentence-regexp <REGEXP>  for end of lines or end of sentences
  -T, --format=tex                generate output as TeX directives
  -W, --word-regexp <REGEXP>      use REGEXP to match each keyword
  -b, --break-file <FILE>         word break characters in this FILE
  -f, --ignore-case               fold lower case to upper case for sorting
  -g, --gap-size <NUMBER>         gap size in columns between output fields
  -i, --ignore-file <FILE>        read ignore word list from FILE
  -o, --only-file <FILE>          read only word list from this FILE
  -r, --references                first field of each line is a reference
  -w, --width <NUMBER>            output width in columns, reference excluded
  -h, --help                      Print help information
  -V, --version                   Print version information

@github-actions
Copy link

GNU testsuite comparison:

Congrats! The gnu test tests/tail-2/inotify-dir-recreate is no longer failing!

@sylvestre
Copy link
Contributor

upstream has:

       ptx - produce a permuted index of file contents

could you please add it?

@chenchiii
Copy link
Contributor Author

Sure, I can add it for more detail.
Should I add this description in the front of the about section (Line 8)?

Output a permuted index, including context, of the words in the input files.

I feel like this line also has a similar description.

@sylvestre
Copy link
Contributor

@chenchiii yes please :)

@chenchiii chenchiii force-pushed the ptx-move-help-strings-to-md-file branch from 03db304 to d971f45 Compare March 6, 2023 00:45
@chenchiii
Copy link
Contributor Author

@sylvestre I added it.

@sylvestre sylvestre merged commit 6508149 into uutils:main Mar 6, 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