debian/gnome-ssh-askpass.1

   1 .TH GNOME-SSH-ASKPASS 1
   2 .SH NAME
   3 gnome\-ssh\-askpass \- prompts a user for a passphrase using GNOME
   4 .SH SYNOPSIS
   5 .B gnome\-ssh\-askpass
   6 .SH DESCRIPTION
   7 .B gnome\-ssh\-askpass
   8 is a GNOME-based passphrase dialog for use with OpenSSH.
   9 It is intended to be called by the
  10 .BR ssh\-add (1)
  11 program and not invoked directly.
  12 It allows
  13 .BR ssh\-add (1)
  14 to obtain a passphrase from a user, even if not connected to a terminal
  15 (assuming that an X display is available).
  16 This happens automatically in the case where
  17 .B ssh\-add
  18 is invoked from one's
  19 .B ~/.xsession
  20 or as one of the GNOME startup programs, for example.
  21 .PP
  22 In order to be called automatically by
  23 .BR ssh\-add ,
  24 .B gnome\-ssh\-askpass
  25 should be installed as
  26 .IR /usr/bin/ssh\-askpass .
  27 .SH "ENVIRONMENT VARIABLES"
  28 The following environment variables are recognized:
  29 .TP
  30 .I GNOME_SSH_ASKPASS_GRAB_SERVER
  31 Causes
  32 .B gnome\-ssh\-askpass
  33 to grab the X server before asking for a passphrase.
  34 .TP
  35 .I GNOME_SSH_ASKPASS_GRAB_POINTER
  36 Causes
  37 .B gnome\-ssh\-askpass
  38 to grab the mouse pointer using
  39 .IR gdk_pointer_grab ()
  40 before asking for a passphrase.
  41 .PP
  42 Regardless of whether either of these environment variables is set,
  43 .B gnome\-ssh\-askpass
  44 will grab the keyboard using
  45 .IR gdk_keyboard_grab ().
  46 .SH AUTHOR
  47 This manual page was written by Colin Watson <cjwatson@debian.org>
  48 for the Debian system (but may be used by others).
  49 It was based on that for
  50 .B x11\-ssh\-askpass
  51 by Philip Hands.