Fix print_usage and man page mistakes

[ghost]

Usage string is off and this PR fixes it.

[SethFalco]

Just for context, I checked what the client specifications had on this just to make sure we're changing the correct thing.

Indeed, -v should be for --version.

[blueskyson]

Look good to me. Maybe @MasterOdin or @Leandros can take a look.

[ghost]

Turns out that other options, such as --verbose and --version, do exist, on top of -l being non-existent.

[ghost]

Hopefully this will be the last commit. 🙂

[ghost]

If I have time, I can rewrite the arguments so that --version is the only flag, and -v, --verbose is used for verbose.

[ghost]

Not sure what to do with the current usage string. Maybe it should be:

tldr [OPTION] PAGE

or tldr [ --verbose] [-c|-u] [OPTION]... PAGE

But the problem is it doesn't cover options like --render, which takes a file path, for example.

[ghost]

Reverting to the old usage but using tldr [--verbose] [OPTION]... PAGE is much better IMO.

[sbrl]

Just a quick comment or two about behaviour when writing the help. If you do e.g. ls --help, it exits with code 0. This seems to be a well established pattern, so I'd recommend we do the same here in the Node client.

[sbrl]

I assume this exits with code e.g. 1 instead of 0 when printing help? Other commands e.g. ls, tar, etc exit with code 0 when printing help, so we should do the same.

Unless I misunderstood this?

[kbdharun]

Our client specification v1.4 suggests to use a non-zero error code for finding pages but doesn't cover the usage part. (tldr-pages/tldr#4246)

Feel free to update the exit code in this branch.

[sbrl]

* Specifically, a client MUST exit with a non-zero exit code if the page could not be found anywhere.

[ghost]

I assume this exits with code e.g. 1 instead of 0 when printing help? Other commands e.g. ls, tar, etc exit with code 0 when printing help, so we should do the same.

Unless I misunderstood this?

This exits with 1 on a getopt error.

For example:

• tldr -a, which is an unknown argument, exits with 1 and displays a getopt error.
• tldr -v exits with 0 and displays the version.

[ghost]

You can even test this by running these commands:

$ tldr -a 2> /dev/null; echo $?
1
$ tldr -v > /dev/null; echo $?
0

[sbrl]

Ah okay. So can you confirm that when you call e.g. tldr --help it exits with code 0, @4G3NT?

[ghost]

Ah okay. So can you confirm that when you call e.g. tldr --help it exits with code 0, @4G3NT?

Yes, it exits with code 0 because of this code:

if (help_flag) {
    print_usage(argv[0]);
    return EXIT_SUCCESS;
}

[sbrl]

Very cool, many thanks!

[sbrl]

See below comment about exiting with code 0 instead of 1 being preferable when printing help.

[ghost]

And now when you invoke tldr with -r it will output:

$ tldr -r
./tldr: option requires an argument -- 'r'

instead of the last code:

$ tldr -r
tldr: option '-render' requires an argument

[sbrl]

Not sure who is generally responsible for the c client but this seems ready to merge for me.