Add manual pages (templates) describing the CAN protocols and CAN utils.

[socketcan-devel.git] / doc / cangen.1

diff --git a/doc/cangen.1 b/doc/cangen.1
new file mode 100644 (file)
index 0000000..8c648ce
--- /dev/null
+++ b/doc/cangen.1
@@ -0,0 +1,54 @@
+.\" $Id$
+.\"
+.\" Copyright (c) 2002-2007 Volkswagen Group Electronic Research
+.\" 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, the following disclaimer and
+.\"    the referenced file 'COPYING'.
+.\" 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. Neither the name of Volkswagen nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
+.\"
+.\" Alternatively, provided that this notice is retained in full, this
+.\" software may be distributed under the terms of the GNU General
+.\" Public License ("GPL") version 2 as distributed in the 'COPYING'
+.\" file from the main directory of the linux kernel source.
+.\"
+.\" The provided data structures and external interfaces from this code
+.\" are not restricted to be used by modules with a GPL compatible license.
+.\"
+.\" 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.
+.\"
+.\" Send feedback to <socketcan-users@lists.berlios.de>
+.\"
+.TH CANGEN 1 2007-01-29 "Socket CAN" "User Commands"
+.SH NAME
+cangen \- generate CAN traffic to send on a CAN interface
+.SH SYNOPSIS
+.B "cangen ..."
+.SH DESCRIPTION
+.B cangen
+yadda yadda
+.SH "SEE ALSO"
+.BR candump (1),
+.BR cansend (1),
+.BR can (7),
+.BR can-raw (7)