Setup newcoll manpage

From DLXS Documentation

Jump to: navigation, search

Back to foo


NAME
       setup_newcoll

SYNOPSIS
       setup_newcoll [options]

       setup_newcoll [-hvo][-c $COLLNAME][-s $DATASOURCE_DIR][-r $DLXSROOT]

       setup_newcoll -c mycoll  -s /l1/foo/DLXSROOT/prep/s/samplefa/data -r /l1/foo/DLXSROOT

       setup_newcoll --man    Full manual page

Options:
       -c,--coll,--collname  string
               Collection name.  Default is workshopfa. Should not contain funny characters (slashes etc)

       -r,--root,--dlxsroot fullpathtodir
               Full path to $DLXSROOT

       -s,--source,--datasource fullpathtodir
               Full path to source of EAD xml data files.  
               Defaults to $DLXSROOT/prep/s/samplefa/data

       -h,--help
               Prints this help

       -v,--verbose
               Prints detailed messages describing processing.  Multiple invocations 
               increase level of messages: setup_newcoll -v -v -v  prints more messages 
               than setup_newcoll -v

       --version
               Prints version and exits.

       -o,--overwrite
               Overwrite any existing directories and files (Use with caution)

DESCRIPTION
       This program creates directories for a new Findaid Class collection according to the    
       DLXS conventions.  (See http://fdfsfsdfsfsd).  
       It also populates the appropriate directories with template files based on the 
       samplefa collection (with all names changed to the collection name).  
       It also copies the EAD xml files in the $DATASOURCE directory to the appropriate
       collection data directory.

ENVIRONMENT
       The program reads the $DLXSROOT environment variable to set the default $DLXSROOT.  
       It can be overridden with the -r,--root,--dlxsroot fullpathtodir option.


Personal tools