Add fd.1 man page, close #77 #125
Conversation
| @@ -0,0 +1,106 @@ | |||
| .TH FD 1 fd-4.0.0 | |||
| .SH NAME | |||
| fd \- find files | |||
There was a problem hiding this comment.
Maybe this could be a little bit more detailed: "fd - find entries in the filesystem"?
There was a problem hiding this comment.
I took that from the posix man page and sbase man page. Both uses that.
| .TH FD 1 fd-4.0.0 | ||
| .SH NAME | ||
| fd \- find files | ||
| .BR find (1) |
There was a problem hiding this comment.
What is this for? is it a link to find? Do we need this here?
There was a problem hiding this comment.
Yes, this is a link to find since it's on the current description.
doc/fd.1
Outdated
| fd \- find files | ||
| .BR find (1) | ||
| .SH SYNOPSIS | ||
| .B spt |
doc/fd.1
Outdated
| .B \-H, \-\-hidden | ||
| Search hidden files and directories. | ||
| .TP | ||
| .B \-I, \-\-no\-gitignore |
doc/fd.1
Outdated
| .BR gitignore (5) | ||
| files. | ||
| .TP | ||
| .B \-s, \-\-case\-insensitive |
doc/fd.1
Outdated
| .B \-h, \-\-help | ||
| Prints help information. | ||
| .TP | ||
| .B \-v, \-\-version |
doc/fd.1
Outdated
| .TP | ||
| .BI "\-j, \-\-threads " num | ||
| Specifies number of threads to use for searching. (default: number of available | ||
| CPU cores) |
There was a problem hiding this comment.
Can we also add the new option -x, --exec?
doc/fd.1
Outdated
| .TP | ||
| LS_COLORS | ||
| .BR "fd"'s | ||
| color codes for search results. |
There was a problem hiding this comment.
LS_COLORS is also used by ls and typically set by dircolors. Maybe we should say something like: "determines how to colorize the search results, see DIRCOLORS(1)".
There was a problem hiding this comment.
Nice suggestion, I don't have better idea to write this environment part.
doc/fd.1
Outdated
| .SH EXAMPLES | ||
| .TP | ||
| .RI "Find the specific log files in " /var/log . | ||
| $ fd nginx.log /var/log |
There was a problem hiding this comment.
Maybe just use fd nginx /var/log here. The . can actually mean "any character" in a regex, so this does not perform a literal search for "nginx.log".
Maybe in the future we need to redirect `--help` to the man pages? Is there a way for cargo to install the man pages?
|
Fantastic, thank you very much! |
#77