FFINDEX_BUILD(1)

πŸ“¦
version 0.9.9.9 Β· 5 versions
, in ubuntu resolute, ubuntu stonking

🌸 FFINDEX_BUILD β€” ok bestie let's build an index 🌸

Hiii so this is the manual for ffindex_build, and yes it lives in section 1 of the manual (User Commands, if you're keeping score) πŸ’…. Buckle up, we're indexing files like it's nothing.


✨ NAME ✨

ffindex_build β€” build a file index from files chilling in directories. It's giving "organize my whole life in one command" energy πŸ—‚οΈβœ¨


πŸ¦‹ DESCRIPTION πŸ¦‹

Okay so here's the whole vibe, the actual usage line, character for character, no notes:

USAGE: ffindex_build [-a|-v] [-s] [-f file]* OUT_DATA_FILE
OUT_INDEX_FILE [-d 2ND_DATA_FILE -i 2ND_INDEX_FILE] [DIR_TO_INDEX|FILE]*

Now let's go flag by flag because every single one matters, periodt πŸ’–

  • -a β€” append files/indexes. Also needed if you wanna sort an already existing ffindex, so don't skip it, ok?
  • -d FFDATA_FILE β€” a second ffindex data file, used for inserting/appending. Two data files, one destiny πŸ™ˆ
  • -i FFINDEX_FILE β€” a second ffindex index file, for inserting/appending. The matching bestie to -d fr fr πŸ’ž
  • -f FILE β€” a file that contains a list of file names, one per line. And listen: -f can be specified up to 4096 times. Yes, four thousand ninety-six. Iconic behavior honestly πŸ‘‘
  • -s β€” sort the index file, so that the index can actually be queried. More append operations can still be done without sorting, so you're not locked in forever, bestie.
  • -v β€” print version and other info, then exit. A little "hi, who am I" moment πŸŽ€
  • -h β€” display this help message. The original helpful girl πŸ’…

🌈 ENVIRONMENT 🌈

  • FFINDEX_MAX_INDEX_ENTRIES β€” allocate memory for this number of entries. Manifest that memory, bestie ✨

πŸ“ EXAMPLES πŸ“

Example 1: Create a brand-new ffindex containing all the files from the "bar/" directory β€” say it has myfile1.txt, myfile2.txt in there β€” and sort (-s) it so that, like, ffindex_get can actually use it:

$ ffindex_build -s foo.ffdata foo.ffindex bar/

Example 2: Add (-a) more files: myfile3.txt, myfile4.txt.

$ ffindex_build -a foo.ffdata foo.ffindex myfile3.txt myfile4.txt

Example 3: Oops 😭 forgot to sort it (-s), so just do it afterwards like the main character you are:

$ ffindex_build -as foo.ffdata foo.ffindex

πŸ’€ NOTE πŸ’€

This was compiled with a maximum key/filename length of 63 and a default maximum of 80000000 entries. If those numbers aren't your vibe, you can change them in the sources. That's it, that's the tea 🍡

Designed and implemented by Andreas Hauser <andy@splashground.de> β€” absolute legend behavior, we love to see it 🫢


πŸ‘‘ BUGS πŸ‘‘

User feedback is very welcome, especially bugs, performance issues, and β€” last but definitely not least β€” the convenience of the programs and the API. Tell us if it's not serving πŸ’…

Email Andreas Hauser at hauser@genzentrum.lmu.de πŸ’Œ


lowkey if you found a bug, that's not a you problem, that's a "please email us" problem. no cap. πŸ›

and that's the whole page, bestie β€” you ate this, gn ✨

This was ffindex_build version 0.999, dated January 2026, from FFINDEX_BUILD(1). Love that for us πŸ’–πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from