vsearch icon indicating copy to clipboard operation
vsearch copied to clipboard

individual manpages for each vsearch command

Open frederic-mahe opened this issue 5 years ago • 4 comments

The --rereplicate command would be a good starting point as it accepts only a limited number of options. The manpage could be accessed as such:

man vsearch
man vsearch-rereplicate

Alternatively, per-command help messages (-h or --help) could be easier to find for users not familiar with manpages:

vsearch --help
vsearch --rereplicate --help

frederic-mahe avatar Oct 13 '18 16:10 frederic-mahe

I really like the idea of per-command help messages with -h. This just-in-time teaching really helps new users.

How does this synergize or conflict with #280 Online linkable manual? Could we work on both of these at the same time? I am being way to optimistic?

colinbrislawn avatar Oct 19 '18 18:10 colinbrislawn

hi @colinbrislawn

ideally vsearch users should have access to all three sources of information (help commands, manpages, and online manual), and I appreciate the virtues (or defaults) of each method. Nonetheless, writing a manpage is easy so I think I'll experiment with that first, just to see if that works and what level of redundancy it implies.

frederic-mahe avatar Oct 27 '18 16:10 frederic-mahe

The --rereplicate command would be a good starting point as it accepts only a limited number of options. The manpage could be accessed as such:

man vsearch
man vsearch-rereplicate

Alternatively, per-command help messages (-h or --help) could be easier to find for users not familiar with manpages:

vsearch --help
vsearch --rereplicate --help

vsearch --rereplicate --help gives me following vsearch v2.22.1_linux_x86_64, 15.5GB RAM, 6 cores https://github.com/torognes/vsearch

Fatal error: FASTA output file for rereplicate must be specified with --output

and for man comand its gives following man vsearch-rereplicate No manual entry for vsearch-rereplicate

hafizmtalha avatar Apr 12 '23 10:04 hafizmtalha

vsearch --rereplicate --help

Per-command manpages are not yet implemented.

frederic-mahe avatar Apr 12 '23 14:04 frederic-mahe