randcp.1

.\" Base generated by help2man 1.41.2 and modified to add more details
.
.TH RANDCP "1" "August 2013" "randcp 0.9" "User Commands"

.SH NAME
randcp \- Copy files randomly, optionally matching a pattern

.SH SYNOPSIS
.B randcp
[\fIOPTION\fR...] \fISOURCE DEST\fR

.SH DESCRIPTION
Copy files randomly from SOURCE to DEST. The following options control the
behaviour of the program. The program copies files recursively, without
maintaining the folder structure itself. This behaviour is intended since this
program was written to copy music files randomly without hierachy.

.TP
\fB\-i\fR, \fB\-\-insensitive\fR
Case insensitive match
.TP
\fB\-l\fR, \fB\-\-limit\fR=\fILIMIT\fR
Limit number of copied files. The default is one file.
.TP
\fB\-p\fR, \fB\-\-pattern\fR=\fIPATTERN\fR
Copy files matching PATTERN. By defaut the pattern is based on the POSIX.2 regular
expressions which programs like grep use.
.TP
\fb\-r\fR, \fB\-\-recursive\fR
By default randcp will not try to copy files from the sub-direcories of the
SRC. Specifying this option will allow recursive scan of the directories.
.TP
\fb\-d\fR, \fB\-\-depth\fR=DEPTH\fR
The directory scan will be done only till the depth level in the directory
hierarchy while copying. This option is only useful with recursive.
.TP
\fb\-e\fR, \fB\-\-echo\fR
Print the files that are being copied to the standard output
\fb\-y\fR, \fB\-\-dry\-run\fR
Don't copy the files to the destination, just do a sample run. Useful to test
the regex in PATTERN
.TP
\-?, \fB\-\-help\fR
Give this help list
.TP
\fB\-\-usage\fR
Give a short usage message
.TP
\fB\-V\fR, \fB\-\-version\fR
Print program version
.PP
Mandatory or optional arguments to long options are also mandatory or optional
for any corresponding short options.

.SH NOTES
randcp builds a tree representation of the SRC directory internally to enable
randomizing the results. So if the depth of the SRC directory is high, then
randcp will take a noticeable amount of time in the beginning before the copying
starts, which is indicated from the 'N% copied' output.

.SH "REPORTING BUGS"
Report bugs in the issues tracker page in http://github/santoshs/noncoreutils
or, alternatively send an e-mail to santosh@fossix.org.

.SH COPYRIGHT
Copyright \(co 2013 Santosh Sivaraj.
License GPLv2+: GNU GPL version 2 or later <http://gnu.org/licenses/gpl\-2.0.html>.
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

.SH "SEE ALSO"
regex(3)