MCH: Use absolute path for inclusion
[remote/remote-mci.git] / doc / remote-device-remove.7
blobd22c2db499c7454df694ac6bd5fbcec7bec372ae
1 .\"     Title: remote-device-remove
2 .\"    Author: 
3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
4 .\"      Date: 05/18/2008
5 .\"    Manual: Re-Mote Testbed Framework
6 .\"    Source: remote-mci 2.0.git
7 .\"
8 .TH "REMOTE\-DEVICE\-REMO" "7" "05/18/2008" "remote\-mci 2\.0\.git" "Re\-Mote Testbed Framework"
9 .\" disable hyphenation
10 .nh
11 .\" disable justification (adjust text to left margin only)
12 .ad l
13 .SH "NAME"
14 remote-device-remove - script for cleaning up the Re-Mote device hierarchy
15 .SH "SYNOPSIS"
16 /lib/udev/remote\-device\-remove
17 .sp
18 .SH "DESCRIPTION"
19 This script is designed to be called via a UDEV rule\'s RUN key\. It cleans up after removed motes and notifies the motehost about the changed state of the device hierarchy\.
20 .sp
21 .SH "ENVIRONMENT VARIABLES"
22 .PP
23 ACTION
24 .RS 4
25 This environment variable is set by UDEV\. Unless the value is "remove" the script will exit\.
26 .RE
27 .SH "FILES"
28 .PP
29 /dev/remote/MOTEMAC/tty/control, /dev/remote/MOTEMAC/tty/data
30 .RS 4
31 Symlink to the mote\'s data and control TTY devices\. These are checked for existence in order to determine whether the mote directory and files created by
32 \fBremote\-device\-add(7)\fR
33 should be cleanup\.
34 .RE
35 .PP
36 /var/log/remote\-udev\.log
37 .RS 4
38 Log file for the Re\-Mote UDEV scripts\.
39 .RE
40 .PP
41 /var/run/motehost\.events
42 .RS 4
43 Path to the pipe where the mote host can be notified about the remove event\.
44 .RE
45 .SH "EXAMPLE"
46 This script should usually be run using a UDEV rule similar to the following:
47 .sp
48 .sp
49 .RS 4
50 .nf
51 SUBSYSTEM=="tty", ACTION=="remove", RUN+="/lib/udev/remote\-device\-remove"
52 .fi
53 .RE
54 .SH "COPYRIGHT"
55 .sp
56 .RS 4
57 .nf
58 Copyright (c) 2007 Jonas Fonseca <fonseca@diku\.dk>
59 Copyright (c) 2008 Rostislav Spinar <rostislav\.spinar@cit\.ie>
60 .fi
61 .RE
62 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version\.
63 .sp
64 .SH "SEE ALSO"
65 \fBremote\-device\-add(7)\fR
66 .sp