usage.c File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

 puts ("Usage: rtitan2 [action] [channels] [timespec] input")
 puts ("rtitan2 converts titan2 data files, directories, or disks to")
 puts ("various formats.")
 puts ("rtitan2 can also extract all the other information frames multiplexed in the")
 puts ("titan2 data files (GPS position, battery state etc.).")
 puts ("")
 puts ("Options:")
 puts (" General options.")
 puts (" -q quiet mode: print warning only")
 puts (" -v print some messages during work")
 puts (" -V print lots of messages during work")
 puts ("Titan disk specific actions (no input data):")
 puts (" These options are to be used with data directly obtained")
 puts ("from a TITAN digitizer, and should be applied on the original medium or")
 puts ("a complete copy of the original medium.")
 puts (" -size file read the size.siz file (must be specified before -data)")
 puts (" -index,opt file")
 puts (" read the ndx file")
 puts (" opt is a comma separated list of options:")
 puts (" cache: generate a cache based on the index")
 puts (" tl: generate an event list based on the index")
 puts (" -data file select and read the data.ndx file")
 puts (" -nooffset ignore offset frames (processed by default)")
 puts ("Status analysis (no input data):")
 puts (" This is mainly for internal use in OMNI")
 puts (" -oif,options file.oif")
 puts (" read the Osiris status files and dump a HTML page, optionnally create the tile (GD needed) and the sattelite map")
 puts (" oif options must be coma-separated, the following are defined:")
 puts (" h=0|1* dump the html page")
 puts (" Example: -oif,t=1,v=0,g=1,oef=680001.oef,oaf=680001.oaf 680001.oif > 680001.html")
 puts ("Time processing specific actions:")
 puts (" -tcorr do not correct from internal time shift, check info files. Only the A/D converter delay and filter delays are corrected")
 puts (" -pulsefilter file")
 puts (" read 'file' as a time shift file (.dt), automatically remove the outliers and dump a .flt file")
 puts ("Osiris disk specific actions:")
 puts (" -te file read 'file' as a TriggerEvent file and dump the content in a human-readable form")
 puts ("Miscellaneous")
 puts (" -mergetrigger,m=minsta,w=winlength[,i=ignorelength] expect the standard input to provide TriggerEvent files prepended by a station name and filter triggers generating a trigger is at least minsta stations trigger winthin winlength seconds. ignorelength is used to ignore repeated triggers.")
 puts ("General options:")
 puts (" -o overwrite output files")
 puts (" -daydir output data filesin the JJJ/ directory. JJJ is the julian day")
 puts (" -O filename force the output name")
 puts (" -nameoption option force naming option (1=location, 2=network, 4=channel)")
 puts (" -n use the channel number, not the channel name for file names")
 puts (" -0 warn if more than 10 zeros are detected in the data. Implies -nodata -nocache -noinfo -sac. Do not expect data to be written !")
 puts (" -sta STANAME force station name, ignore the information")
 puts (" -scanall force to scan all the input data, do not try to seek (use with -f)")
 puts (" -localcache force the use of file .LocalCacheFile (for corrupted input)")
 puts (" -nocache do not create nor use the cache")
 puts (" -nodata do not save the data files (for test only)")
 puts (" -noinfo do not create the .info files when extracting data")
 puts (" -minsamples N do not process data frames shorter than N samples")
 puts (" -tdb database use database to overwrite header information. See -tdbdoc (WIP)")
 puts (" -tag TAG extract only the data matching the give tag; by default, no filter is applied; select AUTO to extract general data only (exclusion of non AUTO tags)")
 puts ("Action:")
 puts (" General actions and behaviour.")
 puts (" -howto display the complete documentation")
 puts (" -copy display copyright information")
 puts (" -help display help message")
 puts (" -logdoc display the log file description (see -log)")
 puts (" -tdbdoc display the titan database (TDB) documentation")
 puts (" -version display version string")
 puts (" -event def event definition (for sac): YYYY.MM.DD.hh.mm.ss.sss,lat,lon,dep")
 puts (" -clearcache remove all the cache entries")
 puts (" -tit select titan frames according to timespec")
 puts (" -sac convert to SAC")
 puts (" -sis[,rm] convert to Sismalp, remove mean")
 puts (" -asc convert to ASC (text file)")
 puts (" -bin convert to binary (float)")
 puts (" -segy convert to SEGY (SU, PASSCAL taste)")
 puts (" -seg2 convert to SEG-2 (not tested!)")
 puts (" -mseed,opts convert to Mini-Seed")
 puts (" MiniSeed options must be coma-separated, the following is defined:")
 puts (" -wav convert to WAV")
 puts (" -trig,options perform a sta/lta based trigger")
 puts (" Trigger options must be coma-separated, the following are defined:")
 puts (" -gif,options build one GIF file for each time segment")
 puts (" Image options must be coma-separated, the following are defined:")
 puts (" m=Ymax: force scaling at Ymax, not the data max")
 puts (" Example: -gif,s=1,r=1,t='a nice plot'")
 puts (" -nodisc allow time discontinuity up to 60 seconds (for gif only)")
 puts (" -log extract the station log from the data (gps info, battery etc.)")
 puts (" -time extract the time pulses")
 puts (" -onedt try to create only one dt file (use with -time)")
 puts (" -nopulsefilter")
 puts (" do not automatically reject time pulses out of spec. (use with -time)")
 puts ("Channel selection:")
 puts (" By default all the analogicl chanels are processed. If")
 puts ("aux is selected, then auxiliary channels are also processed.")
 puts (" -chan list process only the channel list given as a,b-c default is all channels")
 puts (" -stream str process only the channels that match the list, default is all channels (see howto)")
 puts (" -aux select the auxiliary channels")
 puts ("Timespec:")
 puts (" If timespec is not set, all the data will be processed. Otherwise, the time must be specified according to this syntax:")
 puts (" -tl[,preevent[,postevent] file")
 puts (" list of time windows. Format: YYYY.MM.DD-hh.mm.ss duration(s)")
 puts (" If preevent is provided, the start time is shifted by the given delay: the time window becomes T-preevent to T+duration. If postevent is provided, the duration from the file is ignored: the time window becomes T-preevent to T+postevent.")
 puts (" -ts length time segments of fixed length, starting at 00:00")
 puts (" A window can be defined in command line using -s, -S, or -F as start and -l, -p, -P, or -T as stop time.")
 puts (" -s YYYY:JJJ:HH:MM:SS.SSS absolute start time (JJJ: day index since 01/01)")
 puts (" -S YYYY:MM:DD:HH:MM:SS.SSS absolute start time")
 puts (" -F <epoch time> absolute start time (seconds since 1970.01.01)")
 puts (" -l length total length of the processed file")
 puts (" -p YYYY:JJJ:HH:MM:SS.SSS absolute stop time (JJJ: day index since 01/01)")
 puts (" -P YYYY:MM:DD:HH:MM:SS.SSS absolute stop time")
 puts (" -T <epoch time> absolute stop time (seconds since 1970.01.01)")
 puts ("Input:")
 puts (" The input selection is mandatory. Please provide a disk,")
 puts ("a day directory, or a list of files.")
 puts (" -disk path process en entire disk (data/ entry)")
 puts (" -day path process a day directory (data/YYYY.MM.DD entry)")
 puts (" -f files... process a list of files")
 puts (" -bof N skip the N first bytes (applies on each file given by -f)")
 puts (" -eof N stop after absolute position N (applies on each file given by -f)")
 puts ("Examples:")
 puts (" rtitan2 -sac -f file.tit")
 puts (" reads the file file.tit and converts the stream for all the")
 puts (" channels in SAC format.")
 puts (" rtitan2 -sac -aux -chan none -f file.tit")
 puts (" reads the file file.tit and extracts the auxiliary channels only")
 puts (" in SAC format.")
 puts (" rtitan2 -log -disk /mount/usb/data > station.log")
 puts (" extracts all the information from the disk mounted on")
 puts (" /mount/usb/data. The standard output is sent to station.log, all")
 puts (" the information frames are decoded.")
 puts (" rtitan2 -ts 1200 -sac -log -disk /mount/usb/data > station.log")
 puts (" same as above but also extract 20minutes long SAC files")
 puts (" To build a day-plot for a given date, use the following command:")
 puts (" rtitan2 -gif,d=1 -S 2006.08.01 -l 86400 -disk /mount/usb/data")
 puts ("Written by Sébastien Judenherc <Sebastien.Judenherc@agecodagis.com>")
 puts ("(Agecodagis SARL: http://www.agecodagis.com <agecodagis@agecodagis.com>).")
 puts ("Some parts are maintained by people mentionned in the header of the")
 puts ("source file.")
 puts ("Copyright (C) 2006 Sébastien Judenherc, Agecodagis SARL.")
 puts ("This is free software; see the source for copying conditions. There is")
 puts ("NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR")
 puts ("PURPOSE. See -copy option.")
 puts ("Report bugs to Sébastien Judenherc <Sebastien.Judenherc@agecodagis.com>")


Function Documentation

puts ( "Report bugs to Sébastien Judenherc <Sebastien.Judenherc@agecodagis.com>"   ) 

puts ( "PURPOSE. See -copy option."   ) 

puts ( "NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR"   ) 

puts ( "This is free software; see the source for copying conditions. There is"   ) 

puts ( "Copyright (C) 2006 Sébastien   Judenherc,
Agecodagis SARL."   
)

puts ( "source file."   ) 

puts ( "Some parts are maintained by people mentionned in the header of the"   ) 

puts ( "(Agecodagis SARL: http://www.agecodagis.com <agecodagis@agecodagis.com>)."   ) 

puts ( "Written by Sébastien Judenherc <Sebastien.Judenherc@agecodagis.com>"   ) 

puts ( " rtitan2 -  gif  ) 

puts ( " To build a day-plot for a given   date,
use the following command:"   
)

puts ( " same as above but also extract 20minutes long SAC files"   ) 

puts ( " rtitan2 -ts 1200 -sac -log -disk /mount/usb/  data,
station.log"   
)

puts ( " the information frames are decoded."   ) 

puts ( " /mount/usb/data. The standard output is sent to station.  log,
all"   
)

puts ( " extracts all the information from the disk mounted on"   ) 

puts ( " rtitan2 -log -disk /mount/usb/  data,
station.log"   
)

puts ( " in SAC format."   ) 

puts ( " reads the file file.tit and extracts the auxiliary channels only"   ) 

puts ( " rtitan2 -sac -aux -chan none -f file.tit"   ) 

puts ( " channels in SAC format."   ) 

puts ( " reads the file file.tit and converts the stream for all the"   ) 

puts ( " rtitan2 -sac -f file.tit"   ) 

puts ( "Examples:"   ) 

puts ( " -eof N stop after absolute position N (applies on each file given by -f)"   ) 

puts ( " -bof N skip the N first bytes (applies on each file given by -f)"   ) 

puts ( " -f files... process a list of files"   ) 

puts ( " -day path process a day directory (data/YYYY.MM.DD entry)"   ) 

puts ( " -disk path process en entire disk (data/ entry)"   ) 

puts ( "a day   directory,
or a list of files."   
)

puts ( " The input selection is mandatory. Please provide a   disk,
 
)

puts ( "Input:"   ) 

puts ( " -T <epoch time> absolute stop time (seconds since 1970.01.01)"   ) 

puts ( " -P YYYY:MM:DD:HH:MM:SS.SSS absolute stop time"   ) 

puts ( " -p YYYY:JJJ:HH:MM:SS.SSS absolute stop time (JJJ: day index since 01/01)"   ) 

puts ( " -l length total length of the processed file"   ) 

puts ( " -F <epoch time> absolute start time (seconds since 1970.01.01)"   ) 

puts ( " -S YYYY:MM:DD:HH:MM:SS.SSS absolute start time"   ) 

puts ( " -s YYYY:JJJ:HH:MM:SS.SSS absolute start time (JJJ: day index since 01/01)"   ) 

puts ( " A window can be defined in command line using -  s,
S,
or-F as start and-  l,
p,
P,
or-T as stop time."   
)

puts ( " -ts length time segments of fixed   length,
starting at 00:00"   
)

puts ( " If preevent is   provided,
the start time is shifted by the given delay:the time window becomes T-preevent to T+duration.If postevent is  provided,
the duration from the file is ignored:the time window becomes T-preevent to T+postevent."   
)

puts ( " list of time windows. Format: YYYY.MM.DD-hh.mm.ss duration(s)"   ) 

puts ( " -tl file"  [, preevent[, postevent]  ) 

puts ( " If timespec is not   set,
all the data will be processed.  Otherwise,
the time must be specified according to this syntax:"   
)

puts ( "Timespec:"   ) 

puts ( " -aux select the auxiliary channels"   ) 

puts ( " -stream str process only the channels that match the   list,
default is all channels(see howto)"   
)

puts ( " -chan list process only the channel list given as   a,
b-c default is all channels"   
)

puts ( "aux is   selected,
then auxiliary channels are also processed."   
)

puts ( " By default all the analogicl chanels are processed. If"   ) 

puts ( "Channel selection:"   ) 

puts ( " do not automatically reject time pulses out of spec. (use with -time)"   ) 

puts ( " -nopulsefilter"   ) 

puts ( " -onedt try to create only one dt file (use with -time)"   ) 

puts ( " -time extract the time pulses"   ) 

puts ( " -log extract the station log from the data (gps info, battery etc.)"   ) 

puts ( " -nodisc allow time discontinuity up to 60 seconds (for gif only)"   ) 

puts ( " Example: -  gif,
= 1,
= 1 
)

puts ( "   m = Ymax: force scaling at Ymax,
not the data max"   
)

puts ( " Image options must be coma-  separated,
the following are defined:"   
)

puts ( " -  gif,
options build one GIF file for each time segment"   
)

puts ( " Trigger options must be coma-  separated,
the following are defined:"   
)

puts ( " -  trig,
options perform a sta/lta based trigger  
)

puts ( " -wav convert to WAV"   ) 

puts ( " MiniSeed options must be coma-  separated,
the following is defined:"   
)

puts ( " -  mseed,
opts convert to Mini-Seed"   
)

puts ( " -seg2 convert to SEG-2 (not tested!)"   ) 

puts ( " -segy convert to SEGY (SU, PASSCAL taste)"   ) 

puts ( " -bin convert to binary (float)"   ) 

puts ( " -asc convert to ASC (text file)"   ) 

puts ( " -sis convert to   Sismalp[, rm],
remove mean"   
)

puts ( " -sac convert to SAC"   ) 

puts ( " -tit select titan frames according to timespec"   ) 

puts ( " -clearcache remove all the cache entries"   ) 

puts ( " -event def event definition (for sac): YYYY.MM.DD.hh.mm.ss.  sss,
lat  ,
lon  ,
dep"   
)

puts ( " -version display version string"   ) 

puts ( " -tdbdoc display the titan database (TDB) documentation"   ) 

puts ( " -logdoc display the log file description (see -log)"   ) 

puts ( " -help display help message"   ) 

puts ( " -copy display copyright information"   ) 

puts ( " -howto display the complete documentation"   ) 

puts ( " General actions and behaviour."   ) 

puts ( "Action:"   ) 

puts ( " -tag TAG extract only the data matching the give tag; by   default,
no filter is applied;select AUTO to extract general data only(exclusion of non AUTO tags)"   
)

puts ( " -tdb database use database to overwrite header information. See -tdbdoc (WIP)"   ) 

puts ( " -minsamples N do not process data frames shorter than N samples"   ) 

puts ( " -noinfo do not create the .info files when extracting data"   ) 

puts ( " -nodata do not save the data files (for test only)"   ) 

puts ( " -nocache do not create nor use the cache"   ) 

puts ( " -localcache force the use of file .LocalCacheFile (for corrupted input)"   ) 

puts ( " -scanall force to scan all the input   data,
do not try to seek(use with-f)"   
)

puts ( " -sta STANAME force station   name,
ignore the information"   
)

puts ( " -0 warn if more than 10 zeros are detected in the data. Implies -nodata -nocache -noinfo -sac. Do not expect data to be written !"   ) 

puts ( " -n use the channel   number,
not the channel name for file names"   
)

puts ( " -nameoption option force naming option (1=location, 2=network, 4=channel)"   ) 

puts ( " -O filename force the output name"   ) 

puts ( " -daydir output data filesin the JJJ/ directory. JJJ is the julian day"   ) 

puts ( " -o overwrite output files"   ) 

puts ( "General options:"   ) 

puts ( " -  mergetrigger,
= minsta,
= winlength[ 
)

puts ( "Miscellaneous"   ) 

puts ( " -te file read 'file' as a TriggerEvent file and dump the content in a human-readable form"   ) 

puts ( "Osiris disk specific actions:"   ) 

puts ( " read 'file' as a time shift file   .dt,
automatically remove the outliers and dump a.flt file"   
)

puts ( " -pulsefilter file"   ) 

puts ( " -tcorr do not correct from internal time   shift,
check info files.Only the A/D converter delay and filter delays are corrected"   
)

puts ( "Time processing specific actions:"   ) 

puts ( " Example: -  oif,
= 1,
= 0,
= 1,
oef  = 680001.oef,
oaf  = 680001.oaf 680001.oif,
680001.html"   
)

puts (  ) 

puts ( " oif options must be coma-  separated,
the following are defined:"   
)

puts ( " read the Osiris status files and dump a HTML   page,
optionnally create the tile(GD needed) and the sattelite map"   
)

puts ( " -  oif,
options file.oif"   
)

puts ( " This is mainly for internal use in OMNI"   ) 

puts ( "Status analysis (no input data):"   ) 

puts ( " -nooffset ignore offset frames (processed by default)"   ) 

puts ( " -data