Add fd.1 man page, close #77 #125
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| .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 There was a problem hiding this comment. Yes, this is a link to find since it's on the current description. |
||
| .SH SYNOPSIS | ||
| .B spt | ||
|
|
||
| .RB [ \-HIsaLp0hV ] | ||
| .RB [ \- d | ||
| .IR depth ] | ||
| .RB [ \-t | ||
| .IR filetype ] | ||
| .RB [ \-e | ||
| .IR ext ] | ||
| .RB [ \-c | ||
| .IR when ] | ||
| .RB [ \-j | ||
| .IR num ] | ||
| .RI [ pattern ] | ||
| .RI [ path ] | ||
| .SH DESCRIPTION | ||
| .B fd | ||
| is a simple, fast and user-friendly alternative to | ||
| .BR find (1). | ||
| .SH OPTIONS | ||
| .TP | ||
| .B \-H, \-\-hidden | ||
| Search hidden files and directories. | ||
| .TP | ||
| .B \-I, \-\-no\-gitignore | ||
|
|
||
| Do not respect any | ||
| .BR gitignore (5) | ||
| files. | ||
| .TP | ||
| .B \-s, \-\-case\-insensitive | ||
|
|
||
| Perform a case-sensitive search (default: smart case). | ||
| .TP | ||
| .B \-a, \-\-absolute\-path | ||
| Show absolute instead of relative paths. | ||
| .TP | ||
| .B \-L, \-\-follow | ||
| Dereference all symbolic links encountered. | ||
| .TP | ||
| .B \-p, \-\-full\-path | ||
| Match | ||
| .I pattern | ||
| against full path. | ||
| .TP | ||
| .B \-0, \-\-print0 | ||
| Print results followed by a null character (instead of newlines). | ||
| .TP | ||
| .B \-h, \-\-help | ||
| Prints help information. | ||
| .TP | ||
| .B \-v, \-\-version | ||
|
|
||
| Prints version information. | ||
| .TP | ||
| .BI "\-d, \-\-max\-depth " levels | ||
| Limit directory traversal to at most | ||
| .I levels | ||
| of depth. | ||
| .TP | ||
| .BI "\-t, \-\-type " c | ||
| Filter search by type: | ||
| .RS | ||
| .IP "f, file" | ||
| regular files | ||
| .IP "d, directories" | ||
| directories | ||
| .IP "s, symlink" | ||
| symbolic links | ||
| .RE | ||
| .TP | ||
| .BI "\-e, \-\-extension " ext | ||
| Filter search results by file extension | ||
| .IR ext . | ||
| .TP | ||
| .BI "\-c, \-\-color " when | ||
| Declare | ||
| .I when | ||
| to use color for the pattern match output: | ||
| .RS | ||
| .IP auto | ||
| Show colors only when standard output is connected to a terminal. (default) | ||
| .IP never | ||
| Do not use colorized output. | ||
| .IP always | ||
| Always use colorized output. | ||
| .RE | ||
| .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 |
||
| .SH ENVIRONMENT | ||
| .TP | ||
| LS_COLORS | ||
| .BR "fd"'s | ||
| color codes for search results. | ||
|
There was a problem hiding this comment.
There was a problem hiding this comment. Nice suggestion, I don't have better idea to write this environment part. |
||
| .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 |
||
| .TP | ||
| Find all Python files that ends with \(dq.py\(dq in the current directory. | ||
| $ fd -e py | ||
| .SH SEE ALSO | ||
| .BR find (1) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe this could be a little bit more detailed: "fd - find entries in the filesystem"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I took that from the posix man page and sbase man page. Both uses that.