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

Options -u (and -uu) as in ripgrep #92

Closed
unhammer opened this issue Oct 10, 2017 · 11 comments · Fixed by #98 or #483
Closed

Options -u (and -uu) as in ripgrep #92

unhammer opened this issue Oct 10, 2017 · 11 comments · Fixed by #98 or #483
Milestone

Comments

@unhammer
Copy link

unhammer commented Oct 10, 2017

As mentioned in #33 , -u as an alias for --no-ignore and -uu as an alias for --no-ignore --hidden would make it easier/less surprising to use this alongside ripgrep.

@sharkdp
Copy link
Owner

sharkdp commented Oct 10, 2017

I'm going to copy over what I said in #33:

I would like to keep the command-line interface as clean and simple as possible (i.e., I don't want the -h text to be several pages long), but adding -u (and -u -u) seems like a good idea. We could possible hide it from the standard help text and add it as a hidden option that would only be mentioned in a man page(?)

@unsignedint
Copy link
Contributor

I would like to take this on, if I may :)

@sharkdp
Copy link
Owner

sharkdp commented Oct 11, 2017

Sure!

@n8henrie
Copy link
Contributor

n8henrie commented Aug 19, 2019

Unfortunately, I can never remember the fd flags to "search everything" when I'm not finding something I know should be there, and today for some reason (to my delight) I tried the ripgrep flag -uuu, and it worked!

However, not finding any documentation about it in the either the --help or manpage was a little disconcerting, which led me to the relevant PR and this discussion.

We could possible hide it from the standard help text and add it as a hidden option that would only be mentioned in a man page(?)

Should something about this be added to the manpage as suggested above?

@sharkdp
Copy link
Owner

sharkdp commented Aug 28, 2019

Sounds like a good idea, yes.

@n8henrie
Copy link
Contributor

n8henrie commented Sep 6, 2019

Is https://github.com/sharkdp/fd/blob/master/doc/fd.1 manually written? ddfa087

I see -uuu appropriately documented in the source code, it's just not in the man page, and even building from source it's not showing up with --help.

I think I can figure out the syntax if this file is just built by hand, but I'd be a little surprised if that was the case.

@sharkdp
Copy link
Owner

sharkdp commented Sep 13, 2019

Is https://github.com/sharkdp/fd/blob/master/doc/fd.1 manually written? ddfa087

No. It's mostly auto-generated.

I see -uuu appropriately documented in the source code, it's just not in the man page, and even building from source it's not showing up with --help.

The option is set to "hidden". This is by design. It was added for users that come from ripgrep, but I chose to not display it in the general help text, as it is just a synonym for -H/-I.

@sharkdp
Copy link
Owner

sharkdp commented Sep 13, 2019

Concerning the man page, we could either add it by hand, or actually add -u to the LONG --help text (but not to the short -h text).

n8henrie added a commit to n8henrie/fd that referenced this issue Sep 16, 2019
@n8henrie
Copy link
Contributor

No. It's mostly auto-generated.

What tool are you using to generate the manpage? Found the option to hide only the short command, so with the above PR -u appears only in long --help, but still not appearing in the manpage.

@sharkdp
Copy link
Owner

sharkdp commented Sep 16, 2019

Actually, I was wrong. I was thinking about my other projects where I used help2man to create an initial version of the man page.

For fd, @pickfire actually manually wrote a man page (see #125 and #77).

@pickfire
Copy link
Contributor

Yes, I indeed did wrote the man page last hacktoberfest, the man pages are based on suckless.org man pages.

sharkdp pushed a commit that referenced this issue Sep 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants