cad6895cb413 v1.0.0

Add a man page from help2man
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Wed, 09 Dec 2015 12:05:19 +0000
parents 2e99c3f5e7ee
children 327d3a0e8a1a
branches/tags v1.0.0
files ffind.1

Changes

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ffind.1	Wed Dec 09 12:05:19 2015 +0000
@@ -0,0 +1,121 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.3.
+.TH FRIENDLY-FIND "1" "December 2015" "friendly-find version 1.0.0" "User Commands"
+.SH NAME
+friendly-find \- manual page for friendly-find version 1.0.0
+.SH SYNOPSIS
+.B ffind
+[\fI\,options\/\fR] \fI\,PATTERN\/\fR
+.SH OPTIONS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.TP
+\fB\-\-version\fR
+print the version and exit
+.TP
+\fB\-d\fR DIR, \fB\-\-dir\fR=\fI\,DIR\/\fR
+root the search in DIR (default .)
+.TP
+\fB\-D\fR N, \fB\-\-depth\fR=\fI\,N\/\fR
+search at most N directories deep (default 25)
+.TP
+\fB\-f\fR, \fB\-\-follow\fR
+follow symlinked directories and search their contents
+.TP
+\fB\-F\fR, \fB\-\-no\-follow\fR
+don't follow symlinked directories (default)
+.TP
+\fB\-0\fR, \fB\-\-print0\fR
+separate matches with a null byte in output
+.TP
+\fB\-l\fR, \fB\-\-literal\fR
+force literal search, even if it looks like a regex
+.TP
+\fB\-v\fR, \fB\-\-invert\fR
+invert match
+.TP
+\fB\-e\fR, \fB\-\-entire\fR
+match PATTERN against the entire path string
+.TP
+\fB\-E\fR, \fB\-\-non\-entire\fR
+match PATTERN against only the filenames (default)
+.TP
+\fB\-p\fR, \fB\-\-full\-path\fR
+print the file's full path
+.TP
+\fB\-P\fR, \fB\-\-relative\-path\fR
+print the file's relative path (default)
+.IP
+Configuring Case Sensitivity:
+.TP
+\fB\-s\fR, \fB\-\-case\-sensitive\fR
+case sensitive matching (default)
+.TP
+\fB\-i\fR, \fB\-\-case\-insensitive\fR
+case insensitive matching
+.TP
+\fB\-S\fR, \fB\-\-case\-smart\fR
+smart case matching (sensitive if any uppercase chars
+are in the pattern, insensitive otherwise)
+.IP
+Configuring Ignoring:
+.TP
+\fB\-b\fR, \fB\-\-binary\fR
+allow binary files (default)
+.TP
+\fB\-B\fR, \fB\-\-no\-binary\fR
+ignore binary files
+.TP
+\fB\-r\fR, \fB\-\-restricted\fR
+restricted search (skip VCS directories, parse all
+ignore files) (default)
+.TP
+\fB\-q\fR, \fB\-\-semi\-restricted\fR
+semi\-restricted search (don't parse VCS ignore files,
+but still skip VCS directories and parse .ffignore)
+.TP
+\fB\-u\fR, \fB\-\-unrestricted\fR
+unrestricted search (don't parse ignore files, but
+still skip VCS directories)
+.TP
+\fB\-a\fR, \fB\-\-all\fR
+don't ignore anything (ALL files can match)
+.TP
+\fB\-I\fR PATTERN, \fB\-\-ignore\fR=\fI\,PATTERN\/\fR
+add a pattern to be ignored (can be given multiple
+times)
+.IP
+Size Filtering:
+.TP
+Sizes can be given as a number followed by a prefix.
+Some examples:
+.IP
+1k, 5kb, 1.5gb, 2g, 1024b
+.TP
+\fB\-\-larger\-than\fR=\fI\,SIZE\/\fR
+match files larger than SIZE (inclusive)
+.TP
+\fB\-\-smaller\-than\fR=\fI\,SIZE\/\fR
+match files smaller than SIZE (inclusive)
+.IP
+Type Filtering:
+.IP
+Possible types are a (all), f (files), d (dirs), r (real), s
+(symlinked), e (real files), c (real dirs), x (symlinked files), y
+(symlinked dirs). If multiple types are given they will be unioned
+together:  \fB\-\-type\fR 'es' would match real files and all symlinks.
+.TP
+\fB\-t\fR TYPE(S), \fB\-\-type\fR=\fI\,TYPE\/\fR(S)
+match only specific types of things (files, dirs, nonsymlinks, symlinks)
+.SH "SEE ALSO"
+The full documentation for
+.B friendly-find
+is maintained as a Texinfo manual.  If the
+.B info
+and
+.B friendly-find
+programs are properly installed at your site, the command
+.IP
+.B info friendly-find
+.PP
+should give you access to the complete manual.