SANE-AIRSCAN(5)       AirScan (eSCL) and WSD SANE backend      SANE-AIRSCAN(5)

<?><?><?> (NAME)
       sane-airscan - <?><?><?><?><?><?> SANE <?><?><?><?>
       <?><?><?><?><?><?><?> <?> <?><?><?><?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?><?><?> (MFP) <?><?><?><?><?> <?><?> AirScan (eSCL)
       <?> WSD

<?><?><?> (DESCRIPTION)
       <?><?><?><?><?><?> sane-airscan <?><?> <?><?><?><?><?><?>
       <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?><?> <<<?><?><?><?> <?><?><?><?><?><?>>> (driverless)
       <?><?><?>. <?><?> <?><?><?> <?><?><?><?> <?><?><?> <?><?><?><?><?><?>
       <?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
       <?><?><?><?><?><?>:


           1. eSCL, also known as AirScan or AirPrint scan
           2. WSD, also known as WS-Scan




<?><?><?><?><?><?><?><?> (CONFIGURATION)
       <?><?><?><?><?> sane-airscan <?><?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?><?> <?><?><?> <?><?> <?><?>
       <?><?><?><?><?><?><?><?> <?><?><?> <?><?><?><?><?><?><?><?>
       <?><?><?><?><?><?>:


           1. /etc/sane.d/airscan.conf
           2. /etc/sane.d/airscan.d/*




       <?><?><?> (syntax) <?><?><?><?> <?><?><?><?><?><?><?><?>
       <?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?><?><?><?> .INI
       <?><?><?>. <?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?><?>
       <?><?><?><?><?> <?><?><?> <?> <?><?> <?><?><?> <?><?><?><?> <?><?><?>
       <?><?><?><?><?> <?><?><?>. <?><?><?><?><?><?><?><?> <?><?>
       <?><?><?><?><?><?><?><?><?> # <?><?> ; <?><?><?><?>
       <?><?><?><?><?><?><?> <?> <?><?> <?><?><?><?><?><?> <?><?>
       <?><?><?><?><?> <?><?><?><?><?>


           # This is a comment
           [section 1]
           variable 1 = value 1  ; and another comment
           variable 2 = value 2




       <?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?>
       <?><?><?><?><?><?> <?><?><?> <?><?><?><?><?> <?> <?><?><?><?><?> <?><?>
       <?><?><?> <?><?><?><?><?><?><?>. <?><?><?> <?><?><?><?><?><?><?><?><?>
       <?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?> <?><?><?> <?><?>
       <?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?><?>
       <?><?><?><?> ("<?><?><?><?><?> <?><?><?>").

<?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?> (CONFIGURATION OF
       DEVICES)
       <?><?><?> <?><?><?><?><?> <?> <?><?><?><?><?><?> <?><?> <?><?>
       <?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?> (LAN
       segment) <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?>
       <?><?> <?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?> <?><?><?>.

       <?><?> <?><?><?> <?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?>
       <?><?><?><?> <?><?><?><?>. <?><?><?><?> <?><?><?><?>:


           1. If computer and scanner are connected via IP router
           2. There are a lot of devices on a corporate network, but
              only few of them are interesting
           3. Automatic discovery works unreliable




       <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?>
       <?><?><?><?><?><?><?> <?><?><?> <?><?><?> <?><?> <?><?> <?><?><?><?>
       <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?>:


           [devices]
           "Kyocera eSCL" = http://192.168.1.102:9095/eSCL, eSCL
           "Kyocera WSD" = http://192.168.1.102:5358/WSDScanner, WSD
           "Device I do not want to see" = disable




       <?><?><?> [devices] <?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?> <?><?>
       <?><?><?><?> <?><?> <?><?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?>
       <?><?><?> <?><?><?><?><?><?> <?><?> <?><?><?> <?><?> <?><?><?><?><?>
       <?> <?><?><?><?> URL <?><?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?>
       <?><?><?><?> <?><?> <?><?> <?><?> <?><?> <?><?><?><?><?><?> (eSCL
       <?><?> WSD) <?><?><?><?><?><?>. <?><?><?> <?><?><?><?><?><?> <?><?><?>
       <?><?><?><?><?> eSCL <?><?><?> <?><?><?><?><?><?>. <?><?><?><?><?><?>
       <?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?> <?><?>
       <?><?><?><?> <?><?><?><?><?> disable <?><?><?><?><?><?> <?><?><?><?>
       URL<?> <?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?><?><?>
       <?><?><?><?>.

       <?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?><?><?><?><?>
       <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?> <?><?> <?><?><?><?>
       <?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?><?><?>
       <?><?><?><?> URL <?><?> <?><?> <?><?><?><?> <?><?><?>
       <?><?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?><?><?> <?><?><?><?>. <?><?><?> <?><?><?> <?><?><?><?>
       protocol:Device Name:URL <?><?> <?><?><?><?><?><?><?>.
       <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?> escl:Kyocera eSCL:http://192.168.1.102:9095/eSCL
       <?> wsd:Kyocera WSD:http://192.168.1.102:5358/WSDScanner <?><?><?><?>.

       <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?><?> URL
       <?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?><?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?><?>
       airscan-discover(1) <?><?><?> <?><?><?><?><?><?><?><?><?> <?><?><?>
       <?><?> <?><?> <?><?><?><?> <?><?><?> <?><?><?><?> <?><?><?><?>
       <?><?><?><?><?> <?><?><?><?> <?><?><?>. <?><?> <?><?><?><?>
       <?><?><?><?><?><?><?> <?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>
       <?><?> <?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?>
       <?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?> <?><?>
       <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?>
       <?><?><?><?><?><?><?><?><?> <?><?><?> <?><?><?> <?><?><?><?><?><?>.

       <?><?><?> <?><?><?><?><?> airscan-discover(1) <?><?> <?><?><?><?>
       <?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?> <?><?><?><?> <?><?><?> <?><?><?><?><?><?><?> <?><?>
       <?><?><?> <?><?><?><?><?><?>. <?><?><?><?> <?><?><?><?> <?><?><?>
       <?><?><?><?> <?><?><?><?><?> IP <?><?><?><?><?><?> <?><?>
       <?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?> <?><?>
       <?><?><?><?> <?><?><?><?> eSCL <?><?><?><?><?> <?><?><?><?> <?>
       <?><?><?><?> URL <?><?> <?><?><?><?><?><?> <?><?><?><?> "/eSCL"
       <?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?> <?><?> <?><?><?><?>
       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?>. <?><?><?>
       <?><?><?><?><?><?><?><?> URL <?><?><?><?><?> <?><?> WSD <?><?>
       <?><?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?>
       <?><?><?><?> <?><?><?> <?><?><?> <?><?><?><?> TCP <?> <?><?><?><?> URL
       <?><?> <?><?><?><?><?><?> <?><?> eSCL <?><?><?><?><?> <?><?><?><?><?>
       <?><?><?>.

       <?><?><?><?> <?><?><?><?><?><?><?><?><?><?> eSCL<?> <?><?><?><?><?> URL
       <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?> unix:// <?><?><?>
       <?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?>
       unix://scanner.sock/eSCL. <?><?><?> <<host>> <?><?> <?><?><?><?> URL<?>
       <?><?><?> <?><?><?><?><?> <?><?><?> <?><?> <?><?>
       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?>
       socket_dir (<?><?> <?><?><?> <?><?><?><?> <?><?><?><?>) <?><?><?><?><?>
       <?><?><?><?><?> <?><?>. <?><?><?><?><?> <?><?><?><?><?> <?><?>
       <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?> TCP <?><?> <?><?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>.

       <?><?><?><?><?><?> <?><?><?><?><?><?><?><?> sane-airscan <?><?>
       <?><?><?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?>
       <?><?><?><?><?><?><?><?><?><?> <?><?><?> <?><?><?> (remote)
       <?><?><?><?><?> <?><?><?><?><?><?>. <?><?><?> <?><?><?><?><?>
       <?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?>
       <?><?> <?><?><?><?><?><?> eSCL/WSD <?><?> <?><?> <?><?><?><?><?><?>
       SANE <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?> saned(8) <?><?>
       <?><?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?><?> <?><?><?><?>
       <?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?><?><?>. <?><?> <?><?><?><?><?> pretend-local = true<?>
       <?><?><?><?><?><?> sane-airscan <?><?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?><?><?><?> <?><?><?> <?><?> <?><?> <?><?><?><?><?>
       <?><?><?><?> <?><?><?><?> SANE <?><?><?><?> <?><?><?>.

<?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?> (CONFIGURATION OPTIONS)
       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?> <?><?>
       <?><?><?> [options] <?><?><?><?> <?><?><?><?><?><?><?><?>. <?><?>
       <?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?><?>
       <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?>:


           [options]
           ; If there are a lot of scanners around and you are only
           ; interested in 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 name (the default) or hardware model name.
           model = network | hardware

           ; If device supports both eSCL and WSD protocol, sane-airscan
           ; may either choose the "best" protocol automatically, or
           ; expose all variants for user, allowing manual protocol selection.
           ; The default is "auto".
           protocol = auto | manual

           ; Discovery of WSD devices may be "fast" or "full". The "fast"
           ; mode works as fast as DNS-SD discovery, but in some cases
           ; may be unreliable. The "full" mode is slow and reliable.
           ; It is also possible to disable automatic discovery
           ; of WSD devices. The default is "fast".
           ws-discovery = fast | full | off

           ; Scanners that use the unix:// schema in their URL can only
           ; specify a socket name (not a full path). The name will be
           ; searched for in the directory specified here.
           ; The default is /var/run.
           socket_dir = /path/to/directory

           ; Configure whether eSCL and WSD devices should be treated as
           ; if they were attached locally. The default behavior considers
           ; them as remote devices that are accessed over the network.
           ; This option has to be changed when exporting a scanner through
           ; saned. The default is "false"
           pretend-local = false | true




<?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?><?> (BLACKLISTING DEVICES)
       <?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?> <?> <?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?>
       <?><?> <?><?><?><?><?> <?><?><?> <?><?><?><?> <?><?><?><?><?><?> <?><?>
       <?><?><?><?> <?><?> <?><?><?> <?><?> <?><?><?><?><?> <?><?><?> <?><?>
       <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?> <?><?><?>
       <?><?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?>.


           [blacklist]
           model = "Xerox*"       ; blacklist by model name
           name  = "HP*"          ; blacklist by network name
           ip    = 192.168.0.1    ; blacklist by address
           ip    = 192.168.0.0/24 ; blacklist the whole subnet




       <?><?><?><?><?><?><?> <?><?><?><?> <?><?> DNS-SD <?><?> <?><?><?>
       <?><?><?><?><?><?><?> <?> WS-Discovery <?><?><?> <?><?><?><?><?><?><?>
       <?><?> <?><?><?><?><?> <?><?><?><?><?><?><?>. <?><?><?><?>
       <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?>
       <?><?><?> <?><?><?><?> <?><?><?> <?><?><?><?> Avahi <?><?><?><?>
       <?><?><?><?> <?><?><?><?> <?> <?><?><?><?><?><?> <?><?> <?><?><?><?>
       DNS-SD <?><?><?><?> <?><?><?> <?><?><?><?> (<?><?> <?><?><?><?><?><?>
       <?><?> <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?> <?><?><?>
       <?><?><?><?><?> WSD <?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?>
       <?><?><?><?> DNS-SD <?><?><?><?> <?><?><?> <?><?><?><?> <?><?><?><?>
       <?><?><?>).

       <?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?> <?><?><?>
       <?><?><?><?><?><?> <?><?><?> <?><?><?><?><?><?><?><?> <?>
       <?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?>.

<?><?><?><?><?><?><?><?><?><?><?> (DEBUGGING)
       <?><?><?><?><?><?> sane-airscan <?><?><?><?><?><?><?><?>
       <?><?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?>
       <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?> <?><?>
       <?><?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?>.

       <?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?> <?><?>
       <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?>
       [debug] <?><?> <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?>
       <?><?><?>:


           [debug]
           ; Enable or disable console logging
           enable = false | true

           ; Enable protocol trace and configure output directory
           ; for trace files. Like in shell, to specify path relative to
           ; the home directory, start it with tilda character, followed
           ; by slash, i.e., "~/airscan/trace". The directory will
           ; be created automatically.
           trace = path

           ; Hex dump all traffic to the trace file (very verbose!)
           hexdump = false | true




<?><?><?><?><?><?><?> (FILES)
       /etc/sane.d/airscan.conf, /etc/sane.d/airscan.d/*
              <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?>

       /usr/LIBDIR/sane/libsane-airscan.so
              <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
              <?><?><?><?><?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?>
              <?><?><?><?><?><?>

<?><?><?><?><?><?><?><?> <?><?><?><?><?> (ENVIRONMENT)
       SANE_DEBUG_AIRSCAN
              <?><?><?> <?><?><?> <?><?><?><?><?> <?><?><?> true <?><?> <?><?>
              <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?>
              <?><?><?><?> <?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?>
              <?><?><?><?><?><?> <?><?> <?><?> stderr <?><?><?>
              <?><?><?><?><?><?><?>

       SANE_CONFIG_DIR
              <?><?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?>
              <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
              <?><?> <?><?><?><?><?> <?><?><?><?><?><?>. <?><?><?>
              <?><?><?><?><?> <?><?><?><?><?><?> <?><?>
              <?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?> <?><?> <?><?>
              <?><?><?><?><?><?> (:) <?><?> <?><?> <?><?><?>
              <?><?><?><?><?><?><?>. <?><?><?>
              <?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?> airscan.conf <?> <?><?><?><?><?><?><?>
              airscan.d<?> <?><?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?><?> (/etc/sane.d) <?><?><?><?><?>
              <?><?><?><?><?><?><?>.

       SANE_AIRSCAN_DEVICE
              <?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?><?>
              <?><?><?><?> <?><?><?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
              <?><?><?><?> <?><?> <?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?>
              <?><?><?><?><?><?><?> <?> <?><?><?> <?><?><?><?><?><?> <?><?>
              <?><?><?><?><?><?><?> <?><?><?><?><?><?>.

              <?><?><?> <?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?><?>
              <?><?><?><?><?> <?><?><?> <?><?> <?><?> <?><?><?><?><?><?> (:)
              <?><?> <?><?><?><?><?><?> <?><?><?> <?><?><?><?><?><?><?>:

              "PROTO:DEVICE NAME:URL"

              <?><?><?><?><?><?><?> <?><?>:

              - PROTO <?><?> escl <?><?><?> <?><?> wsd.
              - DEVICE NAME <?><?> <?><?><?><?><?> <?><?><?><?><?><?><?><?><?>
              <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?>.
              - URL <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?><?>
              <?><?><?> <?><?> <?><?> <?><?><?><?><?><?><?><?><?><?><?> http:
              <?><?> https: <?><?><?><?><?><?><?> <?><?><?><?><?><?>.

              <?><?><?><?><?><?><?>:

              "escl:Kyocera eSCL:http://192.168.1.102:9095/eSCL" (eSCL)
              "wsd:Kyocera WSD:http://192.168.1.102:5358/WSDScanner" (WSD)

              <?><?><?> <?><?><?><?> <?><?><?> <?><?><?><?><?><?>
              <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>
              sane-airscan <?><?><?>.

<?><?><?><?><?> <?><?><?><?><?><?> <?> <?><?><?><?><?><?><?><?> (BUGS AND
       SUPPORT)
       <?><?><?> <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?> <?><?> Issue <?><?> <?><?><?><?> <?><?><?><?><?> <?><?>
       <?><?><?><?><?><?><?> <?><?><?> <?><?><?><?>:
       https://github.com/alexpevzner/sane-airscan

<?><?><?><?><?><?> <?><?><?><?><?><?> (SEE ALSO)
       sane(7), saned (8), scanimage(1), xsane(1), airscan-discover(1)

<?><?><?><?><?><?><?> (AUTHOR)
       Alexander Pevzner <pzz@apevzner.com>

                                  April 2026                   SANE-AIRSCAN(5)