.\" Generated by scdoc 1.11.3
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "yubikey-touch-detector" "1" "2025-01-10"
.PP
.SH NAME
.PP
yubikey-touch-detector - detect when a YubiKey is waiting for a touch
.PP
.SH SYNOPSIS
.PP
\fByubikey-touch-detector\fR [options.\&.\&.\&]
.PP
.SH OPTIONS
.PP
\fB-libnotify\fR
.RS 4
Show desktop notifications using libnotify.\&
.PP
.RE
\fB-no-socket\fR
.RS 4
Disable unix socket notifier.\&
.PP
.RE
\fB-stdout\fR
.RS 4
Print notifications to stdout.\&
.PP
.RE
\fB-v\fR
.RS 4
Enable debug logging.\&
.PP
.RE
\fB-version\fR
.RS 4
Print version information and exit.\&
.PP
.RE
.SH DESCRIPTION
.PP
\fByubikey-touch-detector\fR detects when a YubiKey is waiting for a touch
configuration.\& It is designed to be integrated with other UI components to
display a visible indicator.\&
.PP
.SH ENVIRONMENT
.PP
\fIYUBIKEY_TOUCH_DETECTOR_VERBOSE\fR
.RS 4
Equivalent to specifying \fB-v\fR.\&
.PP
.RE
\fIYUBIKEY_TOUCH_DETECTOR_LIBNOTIFY\fR
.RS 4
Equivalent to specifying \fB-libnotify\fR.\&
.PP
.RE
\fIYUBIKEY_TOUCH_DETECTOR_STDOUT\fR
.RS 4
Equivalent to specifying \fB-stdout\fR.\&
.PP
.RE
\fIYUBIKEY_TOUCH_DETECTOR_NOSOCKET\fR
.RS 4
Equivalent to specifying \fB-no-socket\fR.\&
.PP
.RE
.SH FILES
.PP
\fI$XDG_RUNTIME_DIR/yubikey-touch-detector.\&socket\fR
.RS 4
The socket exposing events shall be created at this locatoin.\&
.PP
.RE
.SH EVENTS
.PP
The following events are emitted over the socket:
.PP
\fIGPG_1\fR
.RS 4
When a GPG operation starts waiting for a touch.\&
.PP
.RE
\fIGPG_0\fR
.RS 4
When a GPG operation stops waiting for a touch.\&
.PP
.RE
\fIU2F_1\fR
.RS 4
When a U2F operation starts waiting for a touch.\&
.PP
.RE
\fIU2F_0\fR
.RS 4
When a U2F operation stops waiting for a touch.\&
.PP
.RE
\fIMAC_1\fR
.RS 4
When a HMAC operation starts waiting for a touch.\&
.PP
.RE
\fIMAC_0\fR
.RS 4
When a HMAC operation stops waiting for a touch.\&
.PP
.RE
.SH SEE ALSO
.PP
ykman, pam_u2f(8)
.PP
.SH LICENCE
.PP
yubikey-touch-detector is distributed under the ISC licence.\&