← Back to branch summary

~ubuntu-branches/debian/sid/hal/sid

« back to all changes in this revision

Viewing changes to doc/man/hal-lock.1

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2007-10-23 12:33:58 UTC
  • Revision ID: james.westby@ubuntu.com-20071023123358-xaf8mjc5n84d5gtz
Tags: upstream-0.5.10
Import upstream version 0.5.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/hal-lock.1
1
 
.\" 
2
 
.\" hal-lock manual page.
3
 
.\" Copyright (C) 2007 David Zeuthen <david@fubar.dk>
4
 
.\"
5
 
.TH HAL-LOCK 1
6
 
.SH NAME
7
 
hal-lock \- lock an interface
8
 
.SH SYNOPSIS
9
 
.PP
10
 
.B hal-lock
11
 
[options]
12
 
 
13
 
.SH DESCRIPTION
14
 
 
15
 
\fIhal-lock\fP can be used to acquire a lock on a given interface
16
 
either on a given device or globally. For more information about both
17
 
the big picture and the semantics of 
18
 
.B HAL
19
 
locks, refer to the \fIHAL spec\fP which can be found in
20
 
.I "/usr/share/doc/hal-0.5.9/spec/hal-spec.html"
21
 
depending on the distribution.
22
 
 
23
 
.SH OPTIONS
24
 
The following options are supported:
25
 
.TP
26
 
.I "--interface"
27
 
The name of the interface to lock.
28
 
.TP
29
 
.I "--run"
30
 
Program to run if the lock was acquired.
31
 
.TP
32
 
.I "--udi"
33
 
The UDI (\fIUnique Device Identifier\fP) of the device object. If this
34
 
is ommitted, the global lock will be tried.
35
 
.TP
36
 
.I "--exclusive"
37
 
Whether the lock can be held by others.
38
 
.TP
39
 
.I "--exit-with-lock"
40
 
Kill the program if the acquired lock is lost. This only makes sense if you pass a specific
41
 
.I UDI
42
 
due to the semantics of HAL locks.
43
 
.TP
44
 
.I "--exit-with-dev"
45
 
Kill the program if the device is removed. This only makes sense if you pass a specific
46
 
.I UDI
47
 
due to the semantics of HAL locks.
48
 
.TP
49
 
.I "--help"
50
 
Print out usage.
51
 
.TP
52
 
.I "--version"
53
 
Print the version.
54
 
 
55
 
.SH RETURN VALUE
56
 
.PP
57
 
This program will attempt to grab a lock on a given interface.
58
 
Unless, a specific 
59
 
.I UDI 
60
 
is given, the global lock will be tried.  If the lock was succesfully
61
 
acquired the program specified by the option --run will be run and
62
 
upon termination this program will exit with exit code 0. If the lock
63
 
wasn't acquired or an error occured while taking the lock, this
64
 
program will exit with a non-zero exit code and the given program will
65
 
not be run.
66
 
 
67
 
 
68
 
.SH NOTES
69
 
.PP
70
 
This program is only useful for launching software that doesn't use
71
 
HAL at all (since such software launched using 
72
 
.I hal-lock 
73
 
would be locked out itself); for example a partition table editor
74
 
.I part-foo
75
 
may use wrapper script like this
76
 
 
77
 
.I hal-lock --interface org.freedesktop.Hal.Device.Storage --exclusive --run /path/to/part-foo-program
78
 
 
79
 
.SH BUGS
80
 
.PP
81
 
Please send bug reports to either the distribution or the HAL
82
 
mailing list, see 
83
 
.I "http://lists.freedesktop.org/mailman/listinfo/hal"
84
 
on how to subscribe.
85
 
 
86
 
.SH SEE ALSO
87
 
.PP
88
 
\&\fIhald\fR\|(8), 
89
 
\&\fIlshal\fR\|(1), 
90
 
\&\fIhal-get-property\fR\|(1),
91
 
\&\fIhal-set-property\fR\|(1),
92
 
\&\fIhal-find-by-property\fR\|(1),
93
 
\&\fIhal-find-by-capability\fR\|(1)
94
 
 
95
 
.SH AUTHOR
96
 
Written by David Zeuthen <david@fubar.dk> with a lot of help from many
97
 
others.
98