00001 puts("Usage: rtitan2 [action] [channels] [timespec] input");
00002 puts("rtitan2 converts titan2 data files, directories, or disks to");
00003 puts("various formats.");
00004 puts("rtitan2 can also extract all the other information frames multiplexed in the");
00005 puts("titan2 data files (GPS position, battery state etc.).");
00006 puts("");
00007 puts("Options:");
00008 puts(" General options.");
00009 puts("");
00010 puts(" -q quiet mode: print warning only");
00011 puts("");
00012 puts(" -v print some messages during work");
00013 puts("");
00014 puts(" -V print lots of messages during work");
00015 puts("");
00016 puts("Titan disk specific actions (no input data):");
00017 puts(" These options are to be used with data directly obtained");
00018 puts("from a TITAN digitizer, and should be applied on the original medium or");
00019 puts("a complete copy of the original medium.");
00020 puts("");
00021 puts(" -size file read the size.siz file (must be specified before -data)");
00022 puts("");
00023 puts(" -index,opt file");
00024 puts(" read the ndx file");
00025 puts("");
00026 puts(" opt is a comma separated list of options:");
00027 puts("");
00028 puts(" cache: generate a cache based on the index");
00029 puts("");
00030 puts(" tl: generate an event list based on the index");
00031 puts("");
00032 puts(" -data file select and read the data.ndx file");
00033 puts("");
00034 puts(" -nooffset ignore offset frames (processed by default)");
00035 puts("");
00036 puts("Status analysis (no input data):");
00037 puts(" This is mainly for internal use in OMNI");
00038 puts("");
00039 puts(" -oif,options file.oif");
00040 puts(" read the Osiris status files and dump a HTML page, optionnally create the tile (GD needed) and the sattelite map");
00041 puts(" oif options must be coma-separated, the following are defined:");
00042 puts(" h=0|1* dump the html page");
00043 puts("");
00044 puts(" v=0*|1 process also the debug parameters");
00045 puts("");
00046 puts(" g=0*|1 create the gps map");
00047 puts("");
00048 puts(" t=0*|1 build the station tile");
00049 puts("");
00050 puts(" tbn=StationName* overwrite tile basename");
00051 puts("");
00052 puts(" oaf=file ouptut the alert state in this file");
00053 puts("");
00054 puts(" oef=file read the error list in this file");
00055 puts("");
00056 puts(" Example: -oif,t=1,v=0,g=1,oef=680001.oef,oaf=680001.oaf 680001.oif > 680001.html");
00057 puts("");
00058 puts("Time processing specific actions:");
00059 puts("");
00060 puts(" -tcorr do not correct from internal time shift, check info files. Only the A/D converter delay and filter delays are corrected");
00061 puts("");
00062 puts("");
00063 puts(" -pulsefilter file");
00064 puts("");
00065 puts(" read 'file' as a time shift file (.dt), automatically remove the outliers and dump a .flt file");
00066 puts("");
00067 puts("Osiris disk specific actions:");
00068 puts("");
00069 puts(" -te file read 'file' as a TriggerEvent file and dump the content in a human-readable form");
00070 puts("");
00071 puts("Miscellaneous");
00072 puts("");
00073 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.");
00074 puts("");
00075 puts("General options:");
00076 puts("");
00077 puts(" -o overwrite output files");
00078 puts("");
00079 puts(" -daydir output data filesin the JJJ/ directory. JJJ is the julian day");
00080 puts("");
00081 puts(" -O filename force the output name");
00082 puts("");
00083 puts(" -nameoption option force naming option (1=location, 2=network, 4=channel)");
00084 puts("");
00085 puts(" -n use the channel number, not the channel name for file names");
00086 puts("");
00087 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 !");
00088 puts("");
00089 puts(" -sta STANAME force station name, ignore the information");
00090 puts("");
00091 puts(" -scanall force to scan all the input data, do not try to seek (use with -f)");
00092 puts("");
00093 puts(" -localcache force the use of file .LocalCacheFile (for corrupted input)");
00094 puts("");
00095 puts(" -nocache do not create nor use the cache");
00096 puts("");
00097 puts(" -nodata do not save the data files (for test only)");
00098 puts("");
00099 puts(" -noinfo do not create the .info files when extracting data");
00100 puts("");
00101 puts(" -minsamples N do not process data frames shorter than N samples");
00102 puts("");
00103 puts(" -tdb database use database to overwrite header information. See -tdbdoc (WIP)");
00104 puts("");
00105 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)");
00106 puts("");
00107 puts("Action:");
00108 puts(" General actions and behaviour.");
00109 puts("");
00110 puts(" -howto display the complete documentation");
00111 puts("");
00112 puts(" -copy display copyright information");
00113 puts("");
00114 puts(" -help display help message");
00115 puts("");
00116 puts(" -logdoc display the log file description (see -log)");
00117 puts("");
00118 puts(" -tdbdoc display the titan database (TDB) documentation");
00119 puts("");
00120 puts(" -version display version string");
00121 puts("");
00122 puts(" -event def event definition (for sac): YYYY.MM.DD.hh.mm.ss.sss,lat,lon,dep");
00123 puts("");
00124 puts(" -clearcache remove all the cache entries");
00125 puts("");
00126 puts(" -tit select titan frames according to timespec");
00127 puts("");
00128 puts(" -sac convert to SAC");
00129 puts("");
00130 puts(" -sis[,rm] convert to Sismalp, remove mean");
00131 puts("");
00132 puts(" -asc convert to ASC (text file)");
00133 puts("");
00134 puts(" -bin convert to binary (float)");
00135 puts("");
00136 puts(" -segy convert to SEGY (SU, PASSCAL taste)");
00137 puts("");
00138 puts(" -seg2 convert to SEG-2 (not tested!)");
00139 puts("");
00140 puts(" -mseed,opts convert to Mini-Seed");
00141 puts("");
00142 puts(" MiniSeed options must be coma-separated, the following is defined:");
00143 puts("");
00144 puts(" b=blocklen (3) defines the block length (0:512b, 1:1K, 2:2K, 3:4K)");
00145 puts("");
00146 puts(" f=format (3) data format (3: 32bits integer, 10: Steim1)");
00147 puts("");
00148 puts(" -wav convert to WAV");
00149 puts("");
00150 puts(" -trig,options perform a sta/lta based trigger");
00151 puts("");
00152 puts(" Trigger options must be coma-separated, the following are defined:");
00153 puts("");
00154 puts(" s=sta (1.0) sta window length (s)");
00155 puts("");
00156 puts(" l=lta (60.0) lta window length (s)");
00157 puts("");
00158 puts(" t=theshold (2.0) threshold");
00159 puts("");
00160 puts(" hp=high pass cut off freq (0.05Hz) ");
00161 puts("");
00162 puts(" lp=low pass cut off freq (20Hz) ");
00163 puts("");
00164 puts(" m=duration: minimum duration");
00165 puts("");
00166 puts(" o=filename: append to filename");
00167 puts("");
00168 puts(" e=filename: append to filename (event list format)");
00169 puts("");
00170 puts(" -gif,options build one GIF file for each time segment");
00171 puts("");
00172 puts(" Image options must be coma-separated, the following are defined:");
00173 puts("");
00174 puts(" s=0|1*: school mode (color plot for events)");
00175 puts("");
00176 puts(" r=0*|1: reverse colors");
00177 puts("");
00178 puts(" d=0*|1: day (drum) mode");
00179 puts("");
00180 puts(" y=0|1*: add y-scale on each trace");
00181 puts("");
00182 puts(" n=0*|1: alternative normalization");
00183 puts("");
00184 puts(" m=Ymax: force scaling at Ymax, not the data max");
00185 puts("");
00186 puts(" o=offset: use this offset and not the average of the data");
00187 puts("");
00188 puts(" u=filename: update the existing gif file (use with d=1)");
00189 puts("");
00190 puts(" t='title string': force title");
00191 puts("");
00192 puts(" Example: -gif,s=1,r=1,t='a nice plot'");
00193 puts("");
00194 puts(" -nodisc allow time discontinuity up to 60 seconds (for gif only)");
00195 puts("");
00196 puts(" -log extract the station log from the data (gps info, battery etc.)");
00197 puts("");
00198 puts(" -time extract the time pulses");
00199 puts("");
00200 puts(" -onedt try to create only one dt file (use with -time)");
00201 puts("");
00202 puts(" -nopulsefilter");
00203 puts(" do not automatically reject time pulses out of spec. (use with -time)");
00204 puts("");
00205 puts("Channel selection:");
00206 puts(" By default all the analogicl chanels are processed. If");
00207 puts("aux is selected, then auxiliary channels are also processed.");
00208 puts("");
00209 puts(" -chan list process only the channel list given as a,b-c default is all channels");
00210 puts("");
00211 puts(" -stream str process only the channels that match the list, default is all channels (see howto)");
00212 puts("");
00213 puts(" -aux select the auxiliary channels");
00214 puts("");
00215 puts("Timespec:");
00216 puts(" If timespec is not set, all the data will be processed. Otherwise, the time must be specified according to this syntax:");
00217 puts("");
00218 puts(" -tl[,preevent[,postevent] file");
00219 puts("");
00220 puts(" list of time windows. Format: YYYY.MM.DD-hh.mm.ss duration(s)");
00221 puts("");
00222 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.");
00223 puts("");
00224 puts(" -ts length time segments of fixed length, starting at 00:00");
00225 puts("");
00226 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.");
00227 puts("");
00228 puts(" -s YYYY:JJJ:HH:MM:SS.SSS absolute start time (JJJ: day index since 01/01)");
00229 puts("");
00230 puts(" -S YYYY:MM:DD:HH:MM:SS.SSS absolute start time");
00231 puts("");
00232 puts(" -F <epoch time> absolute start time (seconds since 1970.01.01)");
00233 puts("");
00234 puts(" -l length total length of the processed file");
00235 puts("");
00236 puts(" -p YYYY:JJJ:HH:MM:SS.SSS absolute stop time (JJJ: day index since 01/01)");
00237 puts("");
00238 puts(" -P YYYY:MM:DD:HH:MM:SS.SSS absolute stop time");
00239 puts("");
00240 puts(" -T <epoch time> absolute stop time (seconds since 1970.01.01)");
00241 puts("");
00242 puts("Input:");
00243 puts(" The input selection is mandatory. Please provide a disk,");
00244 puts("a day directory, or a list of files.");
00245 puts("");
00246 puts(" -disk path process en entire disk (data/ entry)");
00247 puts("");
00248 puts(" -day path process a day directory (data/YYYY.MM.DD entry)");
00249 puts("");
00250 puts(" -f files... process a list of files");
00251 puts("");
00252 puts(" -bof N skip the N first bytes (applies on each file given by -f)");
00253 puts("");
00254 puts(" -eof N stop after absolute position N (applies on each file given by -f)");
00255 puts("");
00256 puts("Examples:");
00257 puts("");
00258 puts(" rtitan2 -sac -f file.tit");
00259 puts("");
00260 puts(" reads the file file.tit and converts the stream for all the");
00261 puts(" channels in SAC format.");
00262 puts("");
00263 puts("");
00264 puts(" rtitan2 -sac -aux -chan none -f file.tit");
00265 puts("");
00266 puts(" reads the file file.tit and extracts the auxiliary channels only");
00267 puts(" in SAC format.");
00268 puts("");
00269 puts("");
00270 puts(" rtitan2 -log -disk /mount/usb/data > station.log");
00271 puts("");
00272 puts(" extracts all the information from the disk mounted on");
00273 puts(" /mount/usb/data. The standard output is sent to station.log, all");
00274 puts(" the information frames are decoded.");
00275 puts("");
00276 puts(" rtitan2 -ts 1200 -sac -log -disk /mount/usb/data > station.log");
00277 puts(" same as above but also extract 20minutes long SAC files");
00278 puts("");
00279 puts(" To build a day-plot for a given date, use the following command:");
00280 puts(" rtitan2 -gif,d=1 -S 2006.08.01 -l 86400 -disk /mount/usb/data");
00281 puts("");
00282 puts("Written by Sébastien Judenherc <Sebastien.Judenherc@agecodagis.com>");
00283 puts("(Agecodagis SARL: http://www.agecodagis.com <agecodagis@agecodagis.com>).");
00284 puts("Some parts are maintained by people mentionned in the header of the");
00285 puts("source file.");
00286 puts("");
00287 puts("Copyright (C) 2006 Sébastien Judenherc, Agecodagis SARL.");
00288 puts("This is free software; see the source for copying conditions. There is");
00289 puts("NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR");
00290 puts("PURPOSE. See -copy option.");
00291 puts("");
00292 puts("Report bugs to Sébastien Judenherc <Sebastien.Judenherc@agecodagis.com>");
00293 puts("");
