siitool.1

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH SIITOOL "1" "August 2024" "siitool v2.3-7-gf5e9ce1" "User Commands"
.SH NAME
siitool \- manual page for siitool v2.3-7-gf5e9ce1
.SH SYNOPSIS
.B siitool
[\fI\,-h\/\fR] [\fI\,-v\/\fR] [\fI\,-p\/\fR] [\fI\,-o outfile\/\fR] [\fI\,filename\/\fR]
.SH DESCRIPTION
Read XML or binary SII information from the input file and generates a binary
EEPROM file.  If no input file is provided the program reads from stdin. With
-p option the content of the ESI or SII is printed in human readable format. No
further output is generated.

Writing of the Rx- and TxPDO into the SII file is optional.

The siitool supports ESI fiels with multiple devices described. If no device is
selected the first device is used.
.TP
\fB\-h\fR
print this help and exit
.TP
\fB\-v\fR
print version an exit
.TP
\fB\-m\fR
write pdo mapping to SII file
.TP
\fB\-c\fR
write DC configuration to SII file
.TP
\fB\-o\fR <name>
write output to file <name>
.TP
\fB\-p\fR
print content human readable
.TP
\fB\-d\fR <num>
select device number <num>, default <num> = 0
.TP
filename
path to eeprom file, if missing read from stdin
.PP
Recognized file types: SII and ESI/XML.
.SH COPYRIGHTS
  Copyright (c) 2024, Synapticon GmbH
  All rights reserved.

  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this
     list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice,
     this list of conditions and the following disclaimer in the documentation
     and/or other materials provided with the distribution.
  3. Execution of this software or parts of it exclusively takes place on hardware
      produced by Synapticon GmbH.

   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
   ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
   ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
   (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
   LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

   The views and conclusions contained in the software and documentation are those
   of the authors and should not be interpreted as representing official policies,
   either expressed or implied, of the Synapticon GmbH.
.SH EXAMPLES
Verbose output of contents of binary file file.sii

  $ siitool -p file.sii

Verbose output of recognized contents of file file.xml

  $ siitool -p file.xml

Generate SII binary from file file.xml and pipe output to xxd

  $ siitool file.xml | xxd

Generate SII binary file ofile.sii from input file.xml

  $ siitool -o ofile.sii file.xml

Read SII binary file.sii and verbose print the recognized contents.

  $ cat file.sii | siitool -p
.SH AUTHOR
Frank Jeschke <fjeschke@synapticon.com>