.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH FFINDEX_BUILD "1" "March 2024" "ffindex_build version: 0.999 (off_t = 64 bits)" "User Commands"
.SH NAME
ffindex_build \- build file index from files in directories
.SH DESCRIPTION
USAGE: ffindex_build [\-a|\-v] [\-s] [\-f file]* OUT_DATA_FILE OUT_INDEX_FILE [\-d 2ND_DATA_FILE \fB\-i\fR 2ND_INDEX_FILE] [DIR_TO_INDEX|FILE]*
.TP
\fB\-a\fR
append files/indexes, also needed for sorting an already existing ffindex
.TP
\fB\-d\fR FFDATA_FILE
a second ffindex data file for inserting/appending
.HP
\fB\-i\fR FFINDEX_FILE a second ffindex index file for inserting/appending
.TP
\fB\-f\fR FILE
file containing a list of file names, one per line
\fB\-f\fR can be specified up to 4096 times
.TP
\fB\-s\fR
sort index file, so that the index can queried.
Another append operations can be done without sorting.
.TP
\fB\-v\fR
print version and other info then exit
.TP
\fB\-h\fR
display this help message
.PP
ENVIRONMENT
.IP
FFINDEX_MAX_INDEX_ENTRIES \- allocate memory for this number of entries
.SS "EXAMPLES:"
.IP
Create a new ffindex containing all files from the "bar/" directory containing
say myfile1.txt, myfile2.txt and sort (\fB\-s\fR) it so that e.g. ffindex_get can use it.
.IP
\f(CW$ ffindex_build -s foo.ffdata foo.ffindex bar/\fR
.IP
Add (\fB\-a\fR) more files: myfile3.txt, myfile4.txt.
.IP
\f(CW$ ffindex_build -a foo.ffdata foo.ffindex myfile3.txt myfile4.txt\fR
.IP
Oops, forgot to sort it (\fB\-s\fR) so do it afterwards:
.IP
\f(CW$ ffindex_build -as foo.ffdata foo.ffindex\fR
.SS "NOTE:"
.IP
Compiled with a maximum key/filename length is 63 and
default maximum entries 80000000.
This can be changed in the sources.
.PP
Designed and implemented by Andreas Hauser <andy@splashground.de>.
.SH BUGS
User feedback is welcome, especially bugs, performance issues and last but not least convenience of the programs and \s-1API\s0.
.PP
Email Andreas Hauser hauser@genzentrum.lmu.de.