Scroll to navigation

WOFI-PASS(1) General Commands Manual WOFI-PASS(1)

NAME

wofi-pass - pass support for wofi

SYNOPSIS

wofi-pass [OPTIONS...]

OPTIONS

Autotype whatever entry is chosen.
Copy to clipboard. Defaults to wl-copy if no cmd is given.
Use the name of the password file as username.
Show the help message
Don't show field choice if password file only contains password.
Type the selection instead of copying to clipboard. Defaults to wtype if no cmd is given.

CONFIGURATION FILE

One way to customize the wofi-pass behavior is to change the configuration file. wofi-pass does not require a configuration file, but searches the following paths for a valid configuration file at every startup:

○
${WOFI_PASS_CONFIG}
○
${XDG_CONFIG_HOME}/wofi-pass/config
○
/etc/wofi-pass.conf

wofi-pass only reads the first configuration file it finds. The order of searching is the same as in the list above.

If the environment variable ${XDG_CONFIG_HOME} is not set, it is replaced by the default value ${HOME}/.config.

CONFIGURATION VARIABLES

The following varialbes can be redefined in configuration file.

COMMON

Path to the pass storage files. Default: ${HOME}/.password-store

COMMANDS

Command to redirect the output to the clipboard. Default: wl-copy
Command to type the output. Default: wcopy -

PASS FIELDS

pass field to be used as username for autotype. Default: username

PASSWORD FILES

wofi-pass assumes password files are formatted like the following:

Th3Gr3at3stPassw0rd
username: JohnDoe
email: john@example.com
otpauth://totp/example?secret=ABCDCBABCDCBABCD
pin: 1234

Note that the password is ALWAYS on the first line.

AUTOTYPE

The function autotype activates a formatted output of a pass entry.

The autotype function can be activated in 3 different ways:

1.
by setting the option -a the selected entry will be output formatted
2.
selecting the field autotype will output the entry formatted
3.
adding the field autotype_always to the pass entry, this entry will always be output formatted.

AUTOTYPE FORMAT

The format of the autotype is by default is as follows:

username :tab pass

and is defined by WOFI_PASS_AUTOTYPE. The autotype format string consists of cobination of keywords and pass fields separated by a space. The keywords are the follows:

:tab
Type the Tab-key if type mode active else output \t.
:space
Type the Space-key if type mode active else output " ".
:enter
Type the Enter-key if type mode active else output \n.
:delay
Delay the output for a specified time. The time is defined by WOFI_PASS_DELAY in seconds, where the default value is 2 seconds. Is only executed when type mode is active.
:otp
Output the One Time Password
:password
Output the password
:username
Output the username field, defined by PASS_FIELD_USERNAME
:path
Output the filename of selected :pass entry

All other entries are interpreted as pass fields and output the contents of the respective field.

March 2024