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

"OPERATION"??? #11

Open
rulatir opened this issue Jul 26, 2022 · 1 comment
Open

"OPERATION"??? #11

rulatir opened this issue Jul 26, 2022 · 1 comment

Comments

@rulatir
Copy link

rulatir commented Jul 26, 2022

As of today, this is the entirety of what the --help output says:

EasyCopy v1.0.0

Usage:
  ec OPERATION [options] source target
  ec OPERATION [options] source ... directory
  ec --help
  ec --version

These options are supported:
  -f, --force        overwrite existing files without asking 
  -i, --interactive  ask before overwriting a file 
  -n, --no-clobber   skip existing files 

      --no-config    don't read any config file 
  -V, --verbose      verbose mode 
  -q, --quiet        quiet mode 
      --color=WHEN   whether to colorize the output.
                     WHEN can be 'always', 'auto' (default) or 'never' 

  -h, --help         print this help and exit 
  -v, --version      print version information and exit 

This is free software licensed under the MIT License.
You are welcome to redistribute it under certain conditions,
refer to the license file that is distributed with this software.

Extensive documentation can be accessed through the manpages.

It doesn't list the available "OPERATION"s, and as an Arch Linux user I am out of luck, because the PKGBUILD for this program in AUR (mentioned in the README, which suggests that it might be officially-ish supported) doesn't bundle the manpages in the package (man ec shows help for unrelated openssl ec command).

I think you should do one of the following:

  • list supported OPERATIONs in the --help output,
  • list supported OPERATIONs in the error message shown upon invoking ec without specifying an operation
  • list supported OPERATIONs in the README
  • add --list-operations flag or something like that, and mention it in the output of --help and/or the error message
@scrouthtv
Copy link
Owner

scrouthtv commented Jul 29, 2022

Hey. Thanks for the feedback!

First and foremost: be careful when using ec, there is still one corner case where files can get lost that I can't figure out currently.

What do you think of adding the list of operations like this in the output of --help:

EasyCopy v1.0.0

Usage:
  ec OPERATION [options] source target
  ec OPERATION [options] source ... directory
  ec --help
  ec --version

Where OPERATION is either cp or mv.

These options are supported:

You are right about the aur package being "official". It does package the manpage, it is however named easycopy(1). Another thing I've overlooked. I will add this to the output of --help as well. Or should I rather rename the manpage to match the binary?

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

No branches or pull requests

2 participants