Skip to content

Commit

Permalink
Remove obsolete config options
Browse files Browse the repository at this point in the history
  • Loading branch information
AntonVanAssche committed Apr 19, 2024
1 parent 316d591 commit b69f480
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 23 deletions.
Binary file modified docs/bashpass.conf.1.gz
Binary file not shown.
66 changes: 43 additions & 23 deletions docs/raw/bashpass.conf.1
Original file line number Diff line number Diff line change
@@ -1,59 +1,79 @@
.TH "BASHPASS.CONF" "1" "2023-03-27" "BASHPASS.CONF 2023-03-27" "BASHPASS.CONF" "1"
.TH "BASHPASS.CONF" "1" "2024-04-19" "BASHPASS.CONF 2024-04-19" "BASHPASS.CONF" "1"
.ie \n(.g .ds Aq \(aq
.el .ds Aq
.ad l
.nh

.SH "NAME"
bashpass.conf \- BashPass configuration file

.SH "SYNOPSIS"
bashpass.conf
.RE

.SH "DESCRIPTION"
The \fBbashpass.conf\fR file is used to configure BashPass. It contains various settings such as the user's email address and GPG key ID.
The \fBbashpass.conf\fR file is used to configure BashPass.
It contains various settings such as the user's GPG key ID.
.RE

.SH "FILE FORMAT"
The file consists of several parameters, each in the format \fBparameter: setting\fR. Values following the colon are strings and do not need to be quoted.
The file consists of several parameters, each in the format \fBparameter: setting\fR.
Values following the colon are strings and do not need to be quoted.
.RE

.SH "PARAMETERS"
\fBlocation\fR
.RS 4
This parameter contains the location where the program will save passwords.

.RE
.PP
\fBtimer\fR
\fBkeyID\fR
.RS 4
This parameter contains the amount of time, in seconds, to wait before clearing the clipboard after copying a password with the \fB--copy\fR (\fB-c\fR) option.
.RE
The GPG key ID used to encrypt and decrypt the password file.
BashPass will prompt for one, if none is found.
.PP

.RE
\fBlength\fR
.RS 4
This parameter contains the default length for generating a new password.
.RE
The preferred default length for newly generated passwords.
Length can still be set manually when generating a new password.
.PP
\fBemail\fR
.RS 4
This parameter contains the user's email address used during GPG key generation.

.RE
.PP
\fBkeyID\fR
\fBlocation\fR
.RS 4
This parameter contains the ID of the GPG key used to encrypt/decrypt passwords.
.RE
The path where BashPass has to store the password file, also known as the password store.
.PP
\fBgitRepo\fR

.RE
\fBtimer\fR
.RS 4
This parameter contains the URL for synchronizing passwords between the local device and a remote git repository.
The preferred time, specified in seconds, BashPass will wait before clearing the clipboard when using the \fB--copy\fR option.
.PP

.SH "EXAMPLE"
\fBkeyID\fR: 2345678
.RE
\fBlength\fR: 20
.RE
\fBlocation\fR: .config/bashpass/passwords
.RE
\fBtimer\fR: 10
.PP

.SH "FILES AND DIRECTORIES"
~/.config/bashpass/bashpass.conf
.RE
.PP

.SH "SEE ALSO"
\fBbashpass\fR(1)
.PP

.SH "AUTHOR"
\fBAnton Van Assche\fR <\fIhttps://www.github.com/AntonVanAssche\fR>
.PP

.SH "BUGS"
For bug reports and other issues regarding \fBBashPass\fR, including suggestions, please report to the GitHub link below, through which the project is developed.
.PP
.RS 2
\fIhttps://github.com/AntonVanAssche/BashPass\fR
<\fIhttps://github.com/AntonVanAssche/BashPass\fR>
.RE

0 comments on commit b69f480

Please sign in to comment.