INSTALL
author Florian Pose <fp@igh-essen.com>
Mon, 25 Sep 2006 15:55:46 +0000
changeset 370 148155bb9abc
parent 355 3a652b240c48
child 380 971d079ff771
permissions -rw-r--r--
Renamed documentation -> doxygen-output, doc -> documentation.
198
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     1
-------------------------------------------------------------------------------
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     2
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     3
This is the INSTALL file of the IgH EtherCAT Master.
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     4
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     5
$Id$
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     6
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     7
-------------------------------------------------------------------------------
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     8
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     9
Building and installing
355
3a652b240c48 Improved INSTALL file.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    10
=======================
3a652b240c48 Improved INSTALL file.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    11
3a652b240c48 Improved INSTALL file.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    12
The first two steps are only necessary, if the kernel sources to compile
3a652b240c48 Improved INSTALL file.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    13
against are not those of the running kernel.
198
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    14
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    15
1) Create a copy of the configuration template:
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    16
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    17
  $ cp ethercat.conf.tmpl ethercat.conf
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    18
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    19
2) Adjust the variables in the configuration file to your needs.
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    20
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    21
3) Build the EtherCAT master and network device driver modules:
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    22
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    23
  $ make
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    24
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    25
4) Install the the EtherCAT master (as root):
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    26
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    27
  # make install
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    28
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    29
  This will create the following files and directories:
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    30
    - /etc/sysconfig/ethercat (configuration file)
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    31
    - /etc/init.d/ethercat    (startup script)
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    32
    - /usr/sbin/rcethercat    (link to startup script)
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    33
355
3a652b240c48 Improved INSTALL file.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    34
  The modules will be placed in /lib/modules/<KERNEL>/ethercat
198
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    35
  (where <KERNEL> is the Linux kernel version configured in ethercat.conf).
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    36
355
3a652b240c48 Improved INSTALL file.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    37
5) Adjust the configuration file /etc/sysconfig/ethercat to your needs.
3a652b240c48 Improved INSTALL file.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    38
198
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    39
-------------------------------------------------------------------------------