Editing Guide to madagascar programs (section)

=user/jennings programs=
==sfsizes==
{| class="wikitable" align="center" cellspacing="0" border="1"
! colspan="4" style="background:#ffdead;" | Display the size of RSF files.
|-
! colspan="4" | sfsizes files=y human=n file1.rsf file2.rsf ...
|-
|  colspan="4" | Prints the element size, number of elements, and number of bytes<br>for a list of RSF files.  Non-RSF files are ignored.
|-
| ''bool   '' || '''files=y''' ||  [y/n] || 	If y, print size of each file.  If n, print only total.
|-
| ''bool   '' || '''human=n''' ||  [y/n] || 	If y, print human-readable file size.  If n, print byte count.
|}


This program computes the "theoretical" size in bytes of the data fork of RSF files.  The actual space occupied on disk may be different and machine-dependent due to disk blocking factors, etc.  This theoretical array size should be reproducible.  It is also fast because the program only reads the RSF headers files, not the actual data.

For example, to get the total size of all RSF files in a directory, in human-readable format, without listing each file:
<pre>
sfsizes files=n human=y *.rsf
</pre>
This will also work because sfsizes simply skips any non-RSF file:
<pre>
sfsizes files=n human=y *
</pre>
==sffiglist==
{| class="wikitable" align="center" cellspacing="0" border="1"
! colspan="4" style="background:#ffdead;" | Compare Vplot files in Fig and Lock directories
|-
! colspan="4" | sffiglist figdir= lockdir= list= show=
|-
|  colspan="4" |
Parameter '''figdir''' is path to Fig directory, default is ./Fig.

<br>Parameter '''lockdir''' is path to Lock directory:
<br>    If '''figdir''' is in $RSFSRC/book/[book]/[chapter]/[section],
<br>        then default '''lockdir''' is $RSFFIGS/[book]/[chapter]/[section].
<br>    If '''figdir''' is not in $RSFSRC/book/[book]/[chapter]/[section],
<br>        then default '''lockdir''' is $RSFALTFIGS/[book]/[chapter]/[section].

<br>Parameter '''list''' controls files to list, default is all.
<br>Parameter '''show''' controls files to flip with sfpen, default is none.

<br>'''list|show''' = none (No files, print only summary.)
<br>'''list|show''' = diff (Files that are different, determined by sfvplotdiff.)
<br>'''list|show''' = miss (Files missing from figdir or lockdir, and different files.)
<br>'''list|show''' = all (All files.)

<br>File list codes:
<br>space   indicates files that are the same.
<br>  -     indicates file in lockdir that is missing from figdir.
<br>  +     indicates extra file in figdir that is missing from lockdir.
<br>number  is return code from sfvplotdiff indicating different files.
|-
| ''string '' || '''figdir=''' ||   || 	fig directory, default = ./Fig
|-
| ''string '' || '''list=''' ||   || 	how much to list [none,diff,miss,all], default = all
|-
| ''string '' || '''lockdir=''' ||   || 	lock directory, default = lock counterpart of figdir
|-
| ''string '' || '''show=''' ||   || 	how much to show [none,diff,miss,all], default = none
|}


This tool lists Vplot files in the "Fig" and "Lock" directories and compares them using sfvplotdiff.

The Fig directory defaults to ./Fig and the Lock directory defaults to the  
corresponding directory where "scons lock" puts things, but either  
default can be overridden with the user parameters '''figdir''' and '''lockdir''' so that, for example,  
files in two different Fig directories can be compared.

The default for the Lock directory has some logic to look in $RSFFIGS  
when Fig is in $RSFSRC/book, or to look in $RSFALTFIGS when Fig is not  
in $RSFSRC/book because I like to keep two different Lock directories:  
one for stuff in book and another for my own stuff that is not in  
book.  However, I tried to make the code default to reasonable things  
if any of these environment variables are not defined.

The tool gives a summary count of files that are the same, files that are different, files in Fig that are missing from Lock, and files in Lock that are missing from Fig.

The parameters '''list''' (default=all) and '''show''' (default=none) control which files are listed or "flipped" with sfpen.  The file listing indicates which files are the same, which are different, and which are missing from Fig or Lock.

For example, to list all the Vplot files in Fig and Lock:
<pre>
sffiglist list=all
</pre>
To list all Vplot files and flip only files that are different:
<pre>
sffiglist list=all show=diff
</pre>