lincan-0.3.3/doc/lincandoc/lincan/readburst.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry>
   3   <!--
   4   <refentryinfo>
   5     <address>
   6       <email>pisa@cmp.felk.cvut.cz</email>
   7     </address>
   8     <author>
   9       <firstname>Pavel</firstname>
  10       <surname>Pisa</surname>
  11     </author>
  12     <date>2004-04-27</date>
  13   </refentryinfo>
  14   -->
  15   <refmeta>
  16     <refentrytitle>readburst</refentrytitle>
  17     <manvolnum>1</manvolnum>
  18   </refmeta>
  19   <refnamediv>
  20     <refname>readburst</refname>
  21     <refpurpose>the utility for continuous messages reception and printing of the message contents</refpurpose>
  22   </refnamediv>
  23   <refsynopsisdiv>
  24     <cmdsynopsis>
  25       <command>readburst</command>
  26       <arg><option>-d <replaceable>candev</replaceable></option></arg>
  27       <arg><option>-m <replaceable>mask</replaceable></option></arg>
  28       <arg><option>-i <replaceable>id</replaceable></option></arg>
  29       <arg><option>-f <replaceable>flags</replaceable></option></arg>
  30       <arg><option>-w <replaceable>sec</replaceable></option></arg>
  31       <arg><option>-p <replaceable>prefix</replaceable></option></arg>
  32       <arg><option>-V</option></arg>
  33       <arg><option>-h</option></arg>
  34       <!-- <arg rep='repeat'><option><replaceable>file</replaceable></option></arg> -->
  35     </cmdsynopsis>
  36   </refsynopsisdiv>
  37   <refsect1>
  38     <title>Description</title>
  39     <para>
  40       The utility <command>readburst</command> can be used to monitor
  41       or log CAN messages received by one CAN message communication object.
  42       Even outgoing transmitted messages can be logged if <emphasis>process local</emphasis>
  43       is globally or explicitly enabled.
  44     </para>
  45   </refsect1>
  46   <refsect1>
  47     <title>OPTIONS</title>
  48     <variablelist>
  49       <varlistentry>
  50         <term><option>-d</option> <option>--device</option></term>
  51         <listitem>
  52           <para>
  53             This options selects <command>readburst</command> target
  54             CAN device. If the option is not specified, default
  55             device name <filename>/dev/can0</filename> is used.
  56           </para>
  57         </listitem>
  58       </varlistentry>
  59       <varlistentry>
  60         <term><option>-m</option> <option>--mask</option></term>
  61         <listitem>
  62           <para>
  63             This option enables to change default mask accepting all messages
  64             to the specified CAN message id mask. The hexadecimal value
  65             has to be prefixed by prefix <constant>0x</constant>.
  66             Numeric value without any prefix is considered as decimal one.
  67           </para>
  68         </listitem>
  69       </varlistentry>
  70       <varlistentry>
  71         <term><option>-i</option> <option>--id</option></term>
  72         <listitem>
  73           <para>
  74             This option specifies CAN message identifier in the acceptance
  75             mask. The accepted CAN messages are then printed by
  76             <command>readburst</command> command.
  77             Only bits corresponding to the non-zero bits of acceptance mask
  78             are compared. Hexadecimal value  has to be prefixed by
  79             any prefix <constant>0x</constant>. Numeric value without
  80             prefix is considered as decimal one.
  81           </para>
  82         </listitem>
  83       </varlistentry>
  84       <varlistentry>
  85         <term><option>-f</option> <option>--flags</option></term>
  86         <listitem>
  87           <para>
  88           Specification of modifiers flags of receiption CAN queur.
  89           Hexadecimal value  has to be prefixed by
  90           prefix <constant>0x</constant>. Numeric value without
  91           any prefix is considered as decimal one.
  92         </para>
  93         <informaltable frame='none'>
  94           <tgroup cols='4'>
  95           <colspec align="left" colwidth="15*"/>
  96           <colspec align="right" colwidth="8*"/>
  97           <colspec align="right" colwidth="10*"/>
  98           <colspec align="left" colwidth="40*"/>
  99           <thead>
 100           <row>
 101             <entry align="center">Bit name</entry>
 102             <entry align="center">Bit number</entry>
 103             <entry align="center">Mask</entry>
 104             <entry align="center">Description</entry>
 105           </row>
 106           </thead>
 107           <tbody>
 108           <row><entry><constant>MSG_RTR</constant></entry><entry>0</entry><entry>0x1</entry>
 109             <entry>Receive RTR or non-RTR messages</entry></row>
 110           <row><entry><constant>MSG_EXT</constant></entry><entry>2</entry><entry>0x4</entry>
 111             <entry>Receive extended/standard messages</entry></row>
 112           <row><entry><constant>MSG_LOCAL</constant></entry><entry>3</entry><entry>0x8</entry>
 113             <entry>Receive local or external messages</entry></row>
 114           <row><entry><constant>MSG_RTR_MASK</constant></entry><entry>8</entry><entry>0x100</entry>
 115             <entry>Take care about <constant>MSG_RTR</constant> bit else
 116               RTR and non-RTR messages are accepted</entry></row>
 117           <row><entry><constant>MSG_EXT_MASK</constant></entry><entry>10</entry><entry>0x400</entry>
 118             <entry>Take care about <constant>MSG_EXT</constant> bit else
 119               extended and standard messages are accepted</entry></row>
 120           <row><entry><constant>MSG_LOCAL_MASK</constant></entry><entry>11</entry><entry>0x800</entry>
 121             <entry>Take care about <constant>MSG_LOCAL</constant> bit else
 122               both local and external messages are accepted</entry></row>
 123           <row><entry><constant>MSG_PROCESSLOCAL</constant></entry><entry>9</entry><entry>0x200</entry>
 124             <entry>Enable processing of the local messages if not explicitly enabled globally
 125             or disabled globally.</entry></row>
 126           </tbody>
 127           </tgroup>
 128           </informaltable>
 129
 130         </listitem>
 131       </varlistentry>
 132       <varlistentry>
 133         <term><option>-w</option> <option>--wait</option></term>
 134         <listitem>
 135           <para>
 136             The number of second the <command>readburst</command>
 137             waits in the <function>select</function> call.
 138           </para>
 139         </listitem>
 140       </varlistentry>
 141       <varlistentry>
 142         <term><option>-p</option> <option>--prefix</option></term>
 143         <listitem>
 144           <para>
 145             The <replaceable>prefix</replaceable> string can is added at beginning
 146             of each printed line. The format specifies <constant>%s</constant>
 147             could be used to add device name into prefix.
 148           </para>
 149         </listitem>
 150       </varlistentry>
 151       <varlistentry>
 152         <term><option>-V</option> <option>--version</option></term>
 153         <listitem>
 154           <para>
 155             Print command version.
 156           </para>
 157         </listitem>
 158       </varlistentry>
 159       <varlistentry>
 160         <term><option>-h</option> <option>--help</option>
 161         </term>
 162         <listitem>
 163           <para>
 164             Print command usage information
 165           </para>
 166         </listitem>
 167       </varlistentry>
 168     </variablelist>
 169   </refsect1>
 170   <!--
 171   <refsect1>
 172     <title>BACKWARDS COMPATIBILITY</title>
 173
 174     <para>
 175       This.
 176     </para>
 177   </refsect1>
 178   <refsect1>
 179     <title>ENVIRONMENT</title>
 180     <para>
 181       The.
 182     </para>
 183   </refsect1>
 184   <refsect1>
 185     <title>COPYRIGHT</title>
 186     <para>
 187       This.
 188     </para>
 189   </refsect1>
 190   <refsect1>
 191     <title>SEE ALSO</title>
 192     <para>
 193       <citerefentry>
 194         <refentrytitle>readburst</refentrytitle><manvolnum>5</manvolnum>
 195       </citerefentry>
 196     </para>
 197   </refsect1>
 198   -->
 199 </refentry>
 200