← Back to branch summary

~ubuntu-branches/ubuntu/feisty/gnupg2/feisty

« back to all changes in this revision

Viewing changes to doc/scdaemon.texi

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2006-11-24 18:48:23 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20061124184823-17ir9m46tl09n9k4
Tags: 2.0.0-4ubuntu1
* Synchronize to Debian, reapply remaining Ubuntu changes to pristine Debian
  version:
  - Remove libpcsclite-dev, libopensc2-dev build dependencies (they are in
    universe).

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/scdaemon.texi
8
8
@cindex command options
9
9
@cindex options, SCDAEMON command
10
10
 
11
 
@c man begin DESCRIPTION
12
 
 
 
11
@manpage scdaemon.1
 
12
@ifset manverb
 
13
.B scdaemon
 
14
\- Smartcard daemon for the GnuPG system
 
15
@end ifset
 
16
 
 
17
@mansect synopsis
 
18
@ifset manverb
 
19
.B  scdaemon
 
20
.RB [ \-\-homedir
 
21
.IR dir ]
 
22
.RB [ \-\-options
 
23
.IR file ]
 
24
.RI [ options ]  
 
25
.B  \-\-server 
 
26
.br
 
27
.B  scdaemon
 
28
.RB [ \-\-homedir
 
29
.IR dir ]
 
30
.RB [ \-\-options
 
31
.IR file ]
 
32
.RI [ options ]  
 
33
.B  \-\-daemon 
 
34
.RI [ command_line ]
 
35
@end ifset
 
36
 
 
37
 
 
38
@mansect description
13
39
The @command{scdaemon} is a daemon to manage smartcards.  It is usually
14
 
invoked by gpg-agent and in general not used directly.
15
 
 
16
 
@c man end
17
 
 
18
 
@xref{Option Index}, for an index to GPG-AGENTS's commands and options.
 
40
invoked by @command{gpg-agent} and in general not used directly.
 
41
 
 
42
@manpause
 
43
@xref{Option Index}, for an index to @command{scdaemon}'s commands and
 
44
options.
 
45
@mancont
19
46
 
20
47
@menu
21
48
* Scdaemon Commands::      List of all commands.
22
49
* Scdaemon Options::       List of all options.
23
50
* Card applications::      Description of card applications.
 
51
* Scdaemon Configuration:: Configuration files.
24
52
* Scdaemon Examples::      Some usage examples.
25
53
* Scdaemon Protocol::      The protocol the daemon uses.
26
54
@end menu
27
55
 
28
 
@c man begin COMMANDS
 
56
@mansect commands
29
57
 
30
58
@node Scdaemon Commands
31
59
@section Commands
73
101
@end table
74
102
 
75
103
 
76
 
@c man begin OPTIONS
 
104
@mansect options
77
105
 
78
106
@node Scdaemon Options
79
107
@section Option Summary
87
115
@file{scdaemon.conf} and expected in the @file{.gnupg} directory directly
88
116
below the home directory of the user.
89
117
 
90
 
@item --homedir @var{dir}
91
 
@opindex homedir
92
 
Set the name of the home directory to @var{dir}. If his option is not
93
 
used, the home directory defaults to @file{~/.gnupg}.  It is only
94
 
recognized when given on the command line.  It also overrides any home
95
 
directory stated through the environment variable @env{GNUPGHOME} or
96
 
(on W32 systems) by means on the Registry entry
97
 
@var{HKCU\Software\GNU\GnuPG:HomeDir}.
 
118
@include opt-homedir.texi
 
119
 
98
120
 
99
121
@item -v
100
122
@item --verbose
109
131
Select the debug level for investigating problems. @var{level} may be
110
132
one of:
111
133
 
112
 
   @table @code
113
 
   @item none
114
 
   no debugging at all.
115
 
   @item basic  
116
 
   some basic debug messages
117
 
   @item advanced
118
 
   more verbose debug messages
119
 
   @item expert
120
 
   even more detailed messages
121
 
   @item guru
122
 
   all of the debug messages you can get
123
 
   @end table
 
134
@table @code
 
135
@item none
 
136
no debugging at all.
 
137
@item basic  
 
138
some basic debug messages
 
139
@item advanced
 
140
more verbose debug messages
 
141
@item expert
 
142
even more detailed messages
 
143
@item guru
 
144
all of the debug messages you can get
 
145
@end table
124
146
 
125
147
How these messages are mapped to the actual debugging flags is not
126
148
specified and may change with newer releaes of this program. They are
139
161
any time without notice.  FLAGS are bit encoded and may be given in
140
162
usual C-Syntax. The currently defined bits are:
141
163
 
142
 
   @table @code
143
 
   @item 0  (1)
144
 
   command I/O
145
 
   @item 1  (2)  
146
 
   values of big number integers 
147
 
   @item 2  (4)
148
 
   low level crypto operations
149
 
   @item 5  (32)
150
 
   memory allocation
151
 
   @item 6  (64)
152
 
   caching
153
 
   @item 7  (128)
154
 
   show memory statistics.
155
 
   @item 9  (512)
156
 
   write hashed data to files named @code{dbgmd-000*}
157
 
   @item 10 (1024)
158
 
   trace Assuan protocol
159
 
   @item 11 (2048)
160
 
   trace APDU I/O to the card.  This may reveal sensitive data.
161
 
   @end table
 
164
@table @code
 
165
@item 0  (1)
 
166
command I/O
 
167
@item 1  (2)  
 
168
values of big number integers 
 
169
@item 2  (4)
 
170
low level crypto operations
 
171
@item 5  (32)
 
172
memory allocation
 
173
@item 6  (64)
 
174
caching
 
175
@item 7  (128)
 
176
show memory statistics.
 
177
@item 9  (512)
 
178
write hashed data to files named @code{dbgmd-000*}
 
179
@item 10 (1024)
 
180
trace Assuan protocol
 
181
@item 11 (2048)
 
182
trace APDU I/O to the card.  This may reveal sensitive data.
 
183
@end table
162
184
 
163
185
@item --debug-all
164
186
@opindex debug-all
256
278
stripping off the two leading dashes.
257
279
 
258
280
 
259
 
@c man begin CARD APPLICATIONS
260
 
 
 
281
@mansect card applications
261
282
@node Card applications
262
283
@section Description of card applications
263
284
 
300
321
@command{gpgsm}.
301
322
 
302
323
 
 
324
@c *******************************************
 
325
@c ***************            ****************
 
326
@c ***************   FILES    ****************
 
327
@c ***************            ****************
 
328
@c *******************************************
 
329
@mansect files
 
330
@node Scdaemon Configuration
 
331
@section Configuration files
 
332
 
 
333
There are a few configuration files to control certain aspects of
 
334
@command{scdaemons}'s operation. Unless noted, they are expected in the
 
335
current home directory (@pxref{option --homedir}).
 
336
 
 
337
@table @file
 
338
 
 
339
@item scdaemon.conf
 
340
@cindex scdaemon.conf
 
341
This is the standard configuration file read by @command{scdaemon} on
 
342
startup.  It may contain any valid long option; the leading two dashes
 
343
may not be entered and the option may not be abbreviated.  This default
 
344
name may be changed on the command line (@pxref{option --options}).
 
345
 
 
346
@item scd-event
 
347
@cindex scd-event
 
348
If this file is present and executable, it will be called on veyer card
 
349
reader's status changed. An example of this script is provided with the
 
350
distribution
 
351
 
 
352
@item reader_@var{n}.status
 
353
This file is created by @command{sdaemon} to let other applications now
 
354
about reader status changes.  Its use is now deprecated in favor of
 
355
@file{scd-event}.
 
356
 
 
357
@end table
 
358
 
303
359
 
304
360
@c 
305
361
@c  Examples
306
362
@c
 
363
@mansect examples
307
364
@node Scdaemon Examples
308
365
@section Examples
309
366
 
318
375
@c 
319
376
@c  Assuan Protocol
320
377
@c
 
378
@manpause
321
379
@node Scdaemon Protocol
322
380
@section Scdaemon's Assuan Protocol
323
381
 
599
657
 
600
658
 
601
659
 
 
660
@mansect see also
 
661
@ifset isman
 
662
@command{gpg-agent}(1),
 
663
@command{gpgsm}(1), 
 
664
@command{gpg2}(1)
 
665
@end ifset
 
666
@include see-also-note.texi
 
667