forked from alexpevzner/sane-airscan
-
Notifications
You must be signed in to change notification settings - Fork 0
/
sane-airscan.5
164 lines (157 loc) · 4.76 KB
/
sane-airscan.5
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "SANE\-AIRSCAN" "5" "December 2019" "" "AirScan (eSCL) SANE backend"
.
.SH "NAME"
\fBsane\-airscan\fR \- SANE backend for AirScan (eSCL) scanners and MFP
.
.SH "DESCRIPTION"
The \fBsane\-airscan\fR implements a SANE backend that provides access network scanners and MFP using eSCL protocol, also known as AirScan or AirPrint scan\.
.
.SH "CONFIGURATION"
The sane\-airscan loads its configuration files from the following places:
.
.IP "" 4
.
.nf
1\. /etc/sane\.d/airscan\.conf
2\. /etc/sane\.d/airscan\.d/*
.
.fi
.
.IP "" 0
.
.P
The configuration file syntax is very similar to the \.INI file syntax\. It consist of sections, each section contains some variables\. Comments are started from # or ; characters and continies until end of line
.
.IP "" 4
.
.nf
# This is a comment
[section 1]
variable 1 = value 1 ; and another comment
variable 2 = value 2
.
.fi
.
.IP "" 0
.
.P
Leading and trailing spaces of variable name and value are striped\. If you want to preserve them, put name or value into quotes ("like this")\.
.
.SH "CONFIGURATION OF DEVICES"
If scanner and computer are connected to the same LAN segment, everything expected to "just work" out of box, without any need of manual configuration\.
.
.P
Unfortunately, automatic configuration doesn\'t work if there is an IP router between computer and scanner\. At this case scanner can be added manually\.
.
.P
To manually configure a device, add the following section to the configuration file:
.
.IP "" 4
.
.nf
[devices]
"Kyocera MFP Scanner" = http://192\.168\.1\.102:9095/eSCL
"Device I don\'t want to see" = disable
.
.fi
.
.IP "" 0
.
.P
The \fB[devices]\fR section contains all manually configured devices, one line per device, and each line contains a device name on a left side of equation and device URL on a rights side\. You may also disable particular device by using the \fBdisable\fR keyword instead of URL\.
.
.P
To figure out the device URL, you need to know its components:
.
.IP "" 4
.
.nf
http://192\.168\.1\.102:9095/eSCL
<\-\-\-\-\-\-\-\-\-\-\-> <\-\-> <\-\->
| | |
| | `\-\- URL path
| `\-\-\-\-\-\-\- IP port
`\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- Device IP address
.
.fi
.
.IP "" 0
.
.P
The most reliable way to obtain it information, is to execute the following command, using a Linux computer, connected to the same LAN segment as as a scanner:
.
.IP "" 4
.
.nf
$ avahi\-browse _uscan\._tcp \-r
= wlp2s0 IPv4 Kyocera ECOSYS M2040dn
hostname = [KM7B6A91\.local]
address = [192\.168\.1\.102]
port = [9095]
txt = ["duplex=T" "is=platen,adf" "cs=color,grayscale,binary"
"UUID=4509a320\-00a0\-008f\-00b6\-002507510eca"
"pdl=application/pdf,image/jpeg" "note="
"ty=Kyocera ECOSYS M2040dn" "rs=eSCL"
"representation=https://\.\.\."
"adminurl=https://\.\.\." "vers=2\.62" "txtvers=1"]
.
.fi
.
.IP "" 0
.
.P
Address and port are on obvious places\. Please notice the "rs=eSCL" record in the txt section \- this is the path component of the URL\.
.
.P
If running avahi\-browse on same LAN segment as a scanner is not possible, you will have to follow a hard way\. Your administrator must know device IP address, consult your device manual for the eSCL port, and the URL path component most likely is the "/eSCL", though on some devices it may differ\.
.
.SH "CONFIGURATION OPTIONS"
Miscellaneous options all goes to the \fB[options]\fR section\. Currently the following options are supported:
.
.IP "" 4
.
.nf
[options]
; If there are a lot of scanners around and you are only
; interested if few of them, disable auto discovery and
; configure scanners manually
discovery = enable | disable
; Choose what SANE apps will show in a list of devices:
; scanner network (the default) name or hardware model name
model = network | hardware
.
.fi
.
.IP "" 0
.
.SH "FILES"
.
.TP
\fB/etc/sane\.d/airscan\.conf\fR, \fB/etc/sane\.d/airscan\.d/*\fR
The backend configuration files
.
.TP
\fB/usr/LIBDIR/sane/libsane\-airscan\.so\fR
The shared library implementing this backend
.
.SH "ENVIRONMENT"
.
.TP
\fBSANE_DEBUG_AIRSCAN\fR
This variable if set to \fBtrue\fR or non\-zero numerical value, enables debug messages, that are printed to stdout
.
.TP
\fBSANE_CONFIG_DIR\fR
This variable alters the search path for configuration files\. This is a colon\-separated list of directories\. These directories are searched for the airscan\.conf configuration file and for the airscan\.d subdirectory, before the standard path (/etc/sane\.d) is searched\.
.
.SH "BUGS AND SUPPORT"
If you have found a bug, please file a GitHub issue on a GitHub project page: \fBhttps://github\.com/alexpevzner/sane\-airscan\fR
.
.SH "SEE ALSO"
sane(7), scanimage(1), xscane(1)
.
.SH "AUTHOR"
Alexander Pevzner <pzz@apevzner\.com>