← Back to branch summary

~ubuntu-branches/ubuntu/saucy/dahdi-tools/saucy

« back to all changes in this revision

Viewing changes to xpp/astribank_is_starting.8

  • Committer: Bazaar Package Importer
  • Author(s): Jean-Michel Dault, Tzafrir Cohen
  • Date: 2010-02-16 13:44:09 UTC
  • mfrom: (1.1.2 upstream) (2.1.1 squeeze)
  • Revision ID: james.westby@ubuntu.com-20100216134409-4y4k26mgzyra537o
Tags: 1:2.2.1-0ubuntu1
http://bugs.debian.org/536257
http://bugs.debian.org/564381
* Merge from Debian pkg-voip.
  * Changes from Debian:
  - debian/control: Change Maintainer
  - debian/control: Removed Uploaders field.
  - debian/control: Removed Debian Vcs-Svn entry and replaced with
      ubuntu-voip Vcs-Bzr, to reflect divergence in packages.
  - debian/control: Package dahdi Depends on  dahdi-dkms | dahdi-source

* From Debian pkg-voip:
[ Tzafrir Cohen ]
* New upstream release (Closes: #536257, #564381).
* Patch 'bashism' dropped: merged upstream. 
* Patch xpp_no_extra_at dropped: merged upstream. 
* Add an example genconf_parameters.
* Compat level 7.
* Bump standars version to 3.8.3.0 (no change needed)
* Udev rules are now in dahdi-linux.
* Patches perl_fix_noserial, perl_fix_transportdir: Fixes for some
  minor perl issues.
* Add the missing ${misc:Depends}, as per lintian. 
* Patch astribank_allow_ignoreend: an extra missing patch from upstream. 
* Patches init_unload_modules and init_unload_oslec: also unload OSLEC
  when unloading all modules.

Show diffs side-by-side

added added

removed removed

Lines of Context:
xpp/astribank_is_starting.8
 
1
.TH "ASTRIBANK_IS_STARTING" "8" "16 August 2009" "" ""
 
2
 
 
3
.SH NAME
 
4
astribank_is_starting \- Mark / check is a Xorcom Astribank (xpp) is starting
 
5
.SH SYNOPSIS
 
6
.B astribank_is_starting [-d] [-v] [-t \fItimeout\fB] <-a|-r|-w>
 
7
 
 
8
.B astribank_is_starting [-d] [-v]
 
9
 
 
10
.B astribank_is_starting -h
 
11
 
 
12
.SH DESCRIPTION
 
13
.B astribank_is_starting
 
14
is an internal tool used by various xpp scripts to mark that there may
 
15
be an Astribank device currently initializing, and to check for that mark.
 
16
 
 
17
Technically the mark is a SysV semaphore.
 
18
 
 
19
.SH OPTIONS
 
20
.B -a
 
21
.RS
 
22
.B Add.
 
23
Set the mark. Should return 0 unless there's an error.
 
24
.RE
 
25
 
 
26
.B -r
 
27
.RS
 
28
.B Remove.
 
29
Reset the mark. Should return 0 unless there's an error.
 
30
.RE
 
31
 
 
32
.BI -t timeout
 
33
.RS
 
34
.B Timeout.
 
35
Set the timeout value for the \fB-w\fR option. Default is 60 seconds.
 
36
.RE
 
37
 
 
38
.B -w
 
39
.RS
 
40
.B Wait.
 
41
Wait for mark to be reset. Should return 0 unless there's an error.
 
42
.RE
 
43
 
 
44
Without -a or -r: return 0 if the mark has been set, or a non-zero value
 
45
otherwise.
 
46
 
 
47
.B -d
 
48
.RS
 
49
Print debug information to stderr.
 
50
.RE
 
51
 
 
52
.B -v
 
53
.RS
 
54
Verbose execution.
 
55
.RE
 
56
 
 
57
.B -h
 
58
.RS
 
59
Displays usage message.
 
60
.RE
 
61
 
 
62
.SH FILES
 
63
.B /proc/sysvipc/sem
 
64
.RS
 
65
If set, the astribank should appear there with the ID 11211168 (0xAB11A0).
 
66
Naturally the ID (or rather, the usage of a semaphore in the first place)
 
67
is an implementation detail that may change.
 
68
.RE
 
69
 
 
70
.SH NOTES
 
71
.B astribank_is_starting
 
72
is used to mark the fact that an Astribank may be currently reenumerating
 
73
(technically: distonnecting and connecting as a new USB device) after
 
74
loading the firmware. Thus the script that loads the firmware 
 
75
(/usr/share/dahdi/xpp_fxloader) uses this utility to set the mark.
 
76
 
 
77
The mark is reset by /usr/share/dahdi/waitfor_xpds , which is typically
 
78
run by the DAHDI init script and waits for all Astribanks to finish
 
79
loading.
 
80
 
 
81
Q: Why do you use a semaphore?
 
82
 
 
83
A: because, unlike the filesystem, it is writable at any given time.
 
84
 
 
85
.SH BUGS
 
86
Option ordering matter. The \fB-v\fR and \fB-d\fR options should preceed
 
87
the actions (\fB-a\fR, \fB-r\fR and \fB-w\fR).
 
88
The \fB-t\fItimeout\fR option should preceed the \fB-w\fR option.
 
89
 
 
90
.SH SEE ALSO
 
91
semctl(3)
 
92
 
 
93
.SH AUTHOR
 
94
This manual page was written by Tzafrir Cohen <tzafrir.cohen@xorcom.com> .
 
95
Permission is granted to copy, distribute and/or modify this document under
 
96
the terms of the GNU General Public License, Version 2 any 
 
97
later version published by the Free Software Foundation.
 
98
 
 
99
On Debian systems, the complete text of the GNU General Public
 
100
License can be found in /usr/share/common-licenses/GPL.