<html><head><meta name="color-scheme" content="light dark"></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">%=================================================================
\section{The alogclip Tool}
%=================================================================
\label{sec_alogclip}
\index{alogclip!Overview}

The \app{alogclip} tool will prune a given \var{.alog} file based on 
a given beginning and end timestamp. This is particularly useful when
a log file contains a sizeable stretch of data logged after mission 
completion, such as data being recorded while the vehicle is being
recovered or sitting idle topside after recovery. 

%=================================================================
\subsection{Command Line Usage for the  alogclip Tool}
\index{alogclip!Command Line Usage}
\index{Command Line Usage!alogclip}

The \app{alogclip} tool is run from the command line with a given
\var{.alog} file, a start time, end time, and the name of a new
\var{.alog} file.  By default, if the named output file exists, the
user will be prompted before overwriting it.  The user prompt can be
bypassed with the \var{-f,--force} option.  The usage options are
listed when the tool is launched with the \var{-h} switch:

\begin{consoleverb}
 $ alogclip --help or -h
\end{consoleverb}

\begin{fileverb}
  Usage: 
    alogclip in.alog mintime maxtime [out.alog] [OPTIONS]
                                                         
  Synopsis:                                              
    Create a new MOOS .alog file from a given .alog file 
    by removing entries outside a given time window.     
                                                         
  Standard Arguments:                                    
    in.alog  - The input logfile.                        
    mintime  - Log entries with timestamps below mintime 
               will be excluded from the output file.    
    maxtime  - Log entries with timestamps above mintime 
               will be excluded from the output file.    
    out.alog - The newly generated output logfile. If no 
               file provided, output goes to stdout.     
                                                         
  Options:                                               
    -h,--help     Display this usage/help message.      
    -v,--version  Display version information.          
    -f,--force    Overwrite an existing output file
    -q,--quiet    Verbose report suppressed at conclusion.
                                                         
  Further Notes:                                         
    (1) The order of arguments may vary. The first alog  
        file is treated as the input file, and the first 
        numerical value is treated as the mintime.       
    (2) Two numerical values, in order, must be given.   
    (3) See also: alogscan, alogrm, aloggrep, alogview   
\end{fileverb}


%=================================================================
\subsection{Example Output from the alogclip Tool}
\index{alogclip!Example Output}

The output shown below was generated from the \var{alpha.alog} file
generated by the Alpha example mission.

\begin{consoleverb}
 $ alogclip alpha.alog new.alog 50 350
\end{consoleverb}

\begin{fileverb}
 Processing input file alpha.alog...
    
 Total lines clipped:      44,988  (44.32 pct)
   Front lines clipped:     5,474 
   Back  lines clipped:    39,514 
 Total chars clipped:   4,200,260  (43.09 pct)
   Front chars clipped:   432,409 
   Back  chars clipped: 3,767,851 
\end{fileverb}

</pre></body></html>