mirror of
https://codeberg.org/scip/anydb.git
synced 2025-12-17 04:20:59 +01:00
fix pod bug
This commit is contained in:
45
anydb.1
45
anydb.1
@@ -1,4 +1,4 @@
|
||||
.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
|
||||
.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
|
||||
.\"
|
||||
.\" Standard preamble:
|
||||
.\" ========================================================================
|
||||
@@ -133,7 +133,7 @@
|
||||
.\" ========================================================================
|
||||
.\"
|
||||
.IX Title "ANYDB 1"
|
||||
.TH ANYDB 1 "2024-12-23" "1" "User Commands"
|
||||
.TH ANYDB 1 "2024-12-25" "1" "User Commands"
|
||||
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
||||
.\" way too many mistakes in technical documents.
|
||||
.if n .ad l
|
||||
@@ -276,7 +276,7 @@ You might as well specify a file directly using the \f(CW\*(C`\-f\*(C'\fR option
|
||||
.PP
|
||||
Values can be encrypted using \fBChaCha20Poly1305\fR when you specify the
|
||||
\&\f(CW\*(C`\-e\*(C'\fR option. Anydb will ask you interactively for a passphrase. You
|
||||
might as well provide the passphrase using the environment variable
|
||||
can also provide the passphrase using the environment variable
|
||||
\&\f(CW\*(C`ANYDB_PASSWORD\*(C'\fR. To encrypt the value, a cryptographically secure
|
||||
key will be derived from the passphrase using the ArgonID2
|
||||
algorithm. Each value can be encrypted with another passphrase. So,
|
||||
@@ -339,7 +339,7 @@ If the value is encrypted, you will be asked for the passphrase to
|
||||
decrypt it. If the environment variable \f(CW\*(C`ANYDB_PASSWORD\*(C'\fR is set, its
|
||||
value will be used instead.
|
||||
.PP
|
||||
There are different output modes you can choos from: simple, wide and
|
||||
There are different output modes you can choose from: simple, wide and
|
||||
json. The \*(L"simple\*(R" mode is the default one, it just prints the value
|
||||
as is. The \*(L"wide\*(R" mode prints a tabular output similar to the \fBlist\fR
|
||||
subcommand, see there for more details. The options \f(CW\*(C`\-n\*(C'\fR and \f(CW\*(C`\-N\*(C'\fR
|
||||
@@ -356,14 +356,16 @@ Usage:
|
||||
.PP
|
||||
.Vb 2
|
||||
\& Usage:
|
||||
\& anydb list [<filter\-regex>] [\-t <tag>] [\-m <mode>] [\-n \-N] [\-T <tpl>] [flags]
|
||||
\& anydb list [<filter\-regex>] [\-t <tag>] [\-m <mode>] [\-n \-N] [\-T <tpl>] [\-i] [flags]
|
||||
\&
|
||||
\& Aliases:
|
||||
\& list, /, ls
|
||||
\&
|
||||
\& Flags:
|
||||
\& \-i, \-\-case\-insensitive filter case insensitive
|
||||
\& \-h, \-\-help help for list
|
||||
\& \-m, \-\-mode string output format (table|wide|json|template), wide is a verbose table. (default \*(Aqtable\*(Aq)
|
||||
\& \-m, \-\-mode string output format (table|wide|json|template),
|
||||
\& wide is a verbose table. (default \*(Aqtable\*(Aq)
|
||||
\& \-n, \-\-no\-headers omit headers in tables
|
||||
\& \-N, \-\-no\-human do not translate to human readable values
|
||||
\& \-t, \-\-tags stringArray tags, multiple allowed
|
||||
@@ -405,6 +407,8 @@ about the syntax, refer to
|
||||
regexp dialect is not \s-1PCRE\s0 compatible, but supports most of its
|
||||
features.
|
||||
.PP
|
||||
If you want to search case insensitive, add the option \f(CW\*(C`\-i\*(C'\fR.
|
||||
.PP
|
||||
You can \- as with the \fBget\fR command \- use other output modes. The
|
||||
default mode is \*(L"table\*(R". The \*(L"wide\*(R" mode is, as already mentioned, a
|
||||
more detailed table. Also supported is \*(L"json\*(R" mode and \*(L"template\*(R"
|
||||
@@ -465,7 +469,7 @@ behavior by setting the environment variable \f(CW\*(C`EDITOR\*(C'\fR appropriat
|
||||
Please note, that this does not work with binary content!
|
||||
.SS "export"
|
||||
.IX Subsection "export"
|
||||
Since the bbold database file is not portable across platforms (it is
|
||||
Since the bbolt database file is not portable across platforms (it is
|
||||
bound to the endianess of the \s-1CPU\s0 it was being created on), you might
|
||||
want to create a backup file of your database. You can do this with
|
||||
the \fBexport\fR subcommand.
|
||||
@@ -599,8 +603,20 @@ required, the template provided applies to every matching entry
|
||||
separatley.
|
||||
.PP
|
||||
The following template variables can be used:
|
||||
.IP "\fBKey\fR \- string =item \fBValue\fR \- string =item \fBBin\fR \- []byte =item \fBCreated\fR \- time.Time =item \fBTags\fR \- []string =item \fBEncrypted\fR bool" 4
|
||||
.IX Item "Key - string =item Value - string =item Bin - []byte =item Created - time.Time =item Tags - []string =item Encrypted bool"
|
||||
.IP "\fBKey\fR \- string" 4
|
||||
.IX Item "Key - string"
|
||||
.PD 0
|
||||
.IP "\fBValue\fR \- string" 4
|
||||
.IX Item "Value - string"
|
||||
.IP "\fBBin\fR \- []byte" 4
|
||||
.IX Item "Bin - []byte"
|
||||
.IP "\fBCreated\fR \- time.Time" 4
|
||||
.IX Item "Created - time.Time"
|
||||
.IP "\fBTags\fR \- []string" 4
|
||||
.IX Item "Tags - []string"
|
||||
.IP "\fBEncrypted\fR bool" 4
|
||||
.IX Item "Encrypted bool"
|
||||
.PD
|
||||
.PP
|
||||
Prepend a single dot (\*(L".\*(R") before each variable name.
|
||||
.PP
|
||||
@@ -627,7 +643,7 @@ Print the values in \s-1CSV\s0 format \s-1ONLY\s0 if they have some tag:
|
||||
.Ve
|
||||
.SH "CONFIGURATION"
|
||||
.IX Header "CONFIGURATION"
|
||||
Anydb looks at the following location for a configuration file, in
|
||||
Anydb looks at the following locations for a configuration file, in
|
||||
that order:
|
||||
.ie n .IP """$HOME/.config/anydb/anydb.toml""" 4
|
||||
.el .IP "\f(CW$HOME/.config/anydb/anydb.toml\fR" 4
|
||||
@@ -643,17 +659,18 @@ that order:
|
||||
.el .IP "or specify one using \f(CW\-c\fR" 4
|
||||
.IX Item "or specify one using -c"
|
||||
.PD
|
||||
.PP
|
||||
The configuration format uses the \s-1TOML\s0 language, refer to
|
||||
<https://toml.io/en/> for more details. The key names correspond to
|
||||
the commandline options in most cases.
|
||||
.Sp
|
||||
.PP
|
||||
Configuration follows a certain precedence: the files are tried to be
|
||||
read in the given order, followed by commandline options. That is, the
|
||||
last configuration file wins, unless the user provides a commandline
|
||||
option, then this setting will be taken.
|
||||
.Sp
|
||||
.PP
|
||||
A complete configuration file might look like this:
|
||||
.Sp
|
||||
.PP
|
||||
.Vb 7
|
||||
\& # defaults
|
||||
\& dbfile = "~/.config/anydb/default.db"
|
||||
@@ -670,7 +687,7 @@ A complete configuration file might look like this:
|
||||
\& [buckets.test]
|
||||
\& encrypt = false
|
||||
.Ve
|
||||
.Sp
|
||||
.PP
|
||||
Under normal circumstances you don't need a configuration
|
||||
file. However, if you want to use different buckets, then this might
|
||||
be a handy option. Buckets are being configured in ini-style with the
|
||||
|
||||
Reference in New Issue
Block a user