Doc Request: Document meanings of file types shown when -v is used

[Brian-at-Baebies]

During savefs operation with -v argument, output looks like:

-[00][ 55%][SYMLINK ] /var/lib/ghostscript/CMap/Adobe-Japan1-UCS2
-[00][ 55%][DIR     ] /var/lib/ghostscript/fonts
-[00][ 55%][REGFILEM] /var/lib/ghostscript/fonts/Fontmap
-[00][ 55%][REGFILEM] /var/lib/ghostscript/fonts/cidfmap
-[00][ 55%][DIR     ] /var/lib/usbutils
-[00][ 55%][REGFILE ] /var/lib/usbutils/usb.ids
-[00][ 55%][DIR     ] /var/lib/apt

Most of the types shown (third [...] field) are pretty obvious to folks with any background knowledge, but I don't know what REGFILEM is and how it differs from REGFILE. Please update the fsarchiver documentation to define all the possible terms that can appear in that field.

[JamesOlvertone]

From the docu "How files are stored":

REGFILE: normal/big regular files (bigger than the threshold) [REGFILE ] these files have their header first (FSA_MAGIC_OBJT) with the file attributes, and then one or several data blocks (depending on how big the file is), and then a file footer (FSA_MAGIC_FILF) with the md5sum of the contents. The md5sum can’t be written in the object header (before the data blocks) because it would require to read the file twice: first pass to compute the checksum, and a second pass to copy the contents the data blocks. (think about a very large file, say 5GB which is written to an fsa archive which is split into small volumes, say 100MB)

REGFILEM:
small regular files (smaller than the threshold) [REGFILEM] small files are written to the archive when we have a full set of small files, or at the end of the savefs/savedir operation. During the savefs, all the small files are stored in a structure called s_regmulti. When this structure is full, it’s copied to the archive and a new one is created.

[Brian-at-Baebies]

Ah, I see, it's in the internals/FILEFORMAT document.

Please consider adding similar text to the manpage so that it's accessible to users who have installed fsarchiver from a package instead of building from source.