Skip to content

Commit

Permalink
bump: version 1.9
Browse files Browse the repository at this point in the history
Signed-off-by: Andrés J. Díaz <[email protected]>
  • Loading branch information
ajdiaz committed Jun 26, 2022
1 parent ef498a0 commit ccd3fc3
Show file tree
Hide file tree
Showing 20 changed files with 331 additions and 77 deletions.
30 changes: 22 additions & 8 deletions man/timeline.7
Original file line number Diff line number Diff line change
@@ -1,7 +1,21 @@
'\" t
.\" Automatically generated by Pandoc 2.14.0.1
.\" Automatically generated by Pandoc 2.17.1.1
.\"
.TH "TIMELINE" "7" "2021-06-14" "Timeline v1.8-32-g96da44d" "Timeline Manual"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "TIMELINE" "7" "2022-06-26" "Timeline v1.8-34-gef498a0" "Timeline Manual"
.hy
.SH NAME
.PP
Expand Down Expand Up @@ -75,7 +89,7 @@ T}@T{
T}@T{
* \f[I]text\f[R] is text of the post
T}@T{
\f[C]P This is a message\f[R]
\f[V]P This is a message\f[R]
T}
T{
R
Expand All @@ -85,7 +99,7 @@ T}@T{
* \f[I]ref\f[R] is the reference to the post to reply.
See \f[B]REFERENCES\f[R] section below for more information.
T}@T{
\f[C]R d4473ee7d3ba45a29efed144f43cc20cc2801be9:1618423758 This is a reply\f[R]
\f[V]R d4473ee7d3ba45a29efed144f43cc20cc2801be9:1618423758 This is a reply\f[R]
T}
T{
T}@T{
Expand All @@ -101,7 +115,7 @@ T}@T{
* \f[I]ref\f[R] is the reference to the post to tag.
See \f[B]REFERENCES\f[R] section below for more information.
T}@T{
\f[C]T d4473ee7d3ba45a29efed144f43cc20cc2801be9:1618423758 tag\f[R]
\f[V]T d4473ee7d3ba45a29efed144f43cc20cc2801be9:1618423758 tag\f[R]
T}
T{
T}@T{
Expand All @@ -117,7 +131,7 @@ T}@T{
* \f[I]ref\f[R] is the reference to the post to score See
\f[B]REFERENCES\f[R] section below for more information.
T}@T{
\f[C]S d4473ee7d3ba45a29efed144f43cc20cc2801be9:1618423758 1\f[R]
\f[V]S d4473ee7d3ba45a29efed144f43cc20cc2801be9:1618423758 1\f[R]
T}
T{
T}@T{
Expand All @@ -135,7 +149,7 @@ T}@T{
\f[I]\[at]all\f[R] for anonymous recipient (see \f[B]tl-crypto\f[R](1)
for more information).
T}@T{
\f[C]E d4473ee7d3ba45a29efed144f43cc20cc2801be9 ZnNkZHNmc2Rmc2QK\f[R]
\f[V]E d4473ee7d3ba45a29efed144f43cc20cc2801be9 ZnNkZHNmc2Rmc2QK\f[R]
T}
T{
T}@T{
Expand Down Expand Up @@ -176,7 +190,7 @@ binary files).
The references are a way to identify an event in the network.
A reference is an EID (event identifier) which has the following format:
.PP
\f[C]\[rs]<account\[rs]>:\[rs]<timestamp\[rs]>[:\[rs]<hmac\[rs]>]\f[R]
\f[V]\[rs]<account\[rs]>:\[rs]<timestamp\[rs]>[:\[rs]<hmac\[rs]>]\f[R]
.PP
Where:
.TP
Expand Down
18 changes: 16 additions & 2 deletions man/tl-abbr.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
.\" Automatically generated by Pandoc 2.14.0.1
.\" Automatically generated by Pandoc 2.17.1.1
.\"
.TH "TL-ABBR" "1" "2021-06-14" "Timeline v1.8-32-g96da44d" "Timeline Manual"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "TL-ABBR" "1" "2022-06-26" "Timeline v1.8-34-gef498a0" "Timeline Manual"
.hy
.SH NAME
.PP
Expand Down
20 changes: 17 additions & 3 deletions man/tl-account.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
.\" Automatically generated by Pandoc 2.14.0.1
.\" Automatically generated by Pandoc 2.17.1.1
.\"
.TH "TL-ACCOUNT" "1" "2021-06-14" "Timeline v1.8-32-g96da44d" "Timeline Manual"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "TL-ACCOUNT" "1" "2022-06-26" "Timeline v1.8-34-gef498a0" "Timeline Manual"
.hy
.SH NAME
.PP
Expand Down Expand Up @@ -84,7 +98,7 @@ unless \f[I]\[en]no-default-sign\f[R] or \f[I]\[en]no-default-encr\f[R].
\f[B]keyrevoke\f[R] [\[en]force] <KeyID>
Revoke the KeyID you pass as argument.
Please note that you cannot revoke current default key for sign or
encrypt (well, actually you can if \f[C]--force\f[R] option is present,
encrypt (well, actually you can if \f[V]--force\f[R] option is present,
but you should generate a new key pair before).
.TP
\f[B]encrkey\f[R] <KeyID>
Expand Down
18 changes: 16 additions & 2 deletions man/tl-alias.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
.\" Automatically generated by Pandoc 2.14.0.1
.\" Automatically generated by Pandoc 2.17.1.1
.\"
.TH "TL-ALIAS" "1" "2021-06-14" "Timeline v1.8-32-g96da44d" "Timeline Manual"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "TL-ALIAS" "1" "2022-06-26" "Timeline v1.8-34-gef498a0" "Timeline Manual"
.hy
.SH NAME
.PP
Expand Down
18 changes: 16 additions & 2 deletions man/tl-config.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
.\" Automatically generated by Pandoc 2.14.0.1
.\" Automatically generated by Pandoc 2.17.1.1
.\"
.TH "TL-CONFIG" "1" "2021-06-14" "Timeline v1.8-32-g96da44d" "Timeline Manual"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "TL-CONFIG" "1" "2022-06-26" "Timeline v1.8-34-gef498a0" "Timeline Manual"
.hy
.SH NAME
.PP
Expand Down
51 changes: 33 additions & 18 deletions man/tl-crypto.7
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
.\" Automatically generated by Pandoc 2.14.0.1
.\" Automatically generated by Pandoc 2.17.1.1
.\"
.TH "TL-CRYPTO" "7" "2021-06-14" "Timeline v1.8-32-g96da44d" "Timeline Manual"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "TL-CRYPTO" "7" "2022-06-26" "Timeline v1.8-34-gef498a0" "Timeline Manual"
.hy
.SH NAME
.PP
Expand Down Expand Up @@ -54,7 +68,7 @@ You can avoid this behaviour adding \f[I]\[en]no-default-encr\f[R] and
encryption and signing, respectively.
See \f[B]tl-account\f[R](1) for more information.
.PP
You can use the command \f[C]tl account keys\f[R] to see the current
You can use the command \f[V]tl account keys\f[R] to see the current
available keys for your account.
.SS Generate keys for already existent account.
.PP
Expand Down Expand Up @@ -93,7 +107,7 @@ Let timeline to handle keys for you.
.SH KEY REVOCATION
.PP
You can revoke a key at any time by the command
\f[C]tl account keyrevoke \[rs]<keyID\[rs]>\f[R].
\f[V]tl account keyrevoke \[rs]<keyID\[rs]>\f[R].
Once the key is revoked another one is automatically selected as primary
key for signing and encryption (if the revoked one was the primary one,
of course).
Expand All @@ -108,16 +122,16 @@ verify old messages.
.SH SIGNING PROCESS
.PP
You can set any key to default as signing key using the command
\f[C]tl account signkey \[rs]<keyID\[rs]>\f[R].
If the key is set then on any event (post, reply\&...) you will sign the
commit with the proper key.
\f[V]tl account signkey \[rs]<keyID\[rs]>\f[R].
If the key is set then on any event (post, reply\&...)
you will sign the commit with the proper key.
You can also change the key to sign using the previous command at any
moment.
.PP
\f[B]WARNING!\f[R] Try to avoid changing the key ID manually in the
configuration file.
Although this is possible, you need to change also the
\f[C].git/config\f[R] file in the proper repository manually, which can
\f[V].git/config\f[R] file in the proper repository manually, which can
provoke some confusion.
Is better to use the \f[B]tl-account\f[R](1) command to do that.
.SH ENCRYPTION PROCESS
Expand All @@ -140,14 +154,14 @@ them setting \f[I]crypto.ignore-anon\f[R] configuration value to
\f[I]true\f[R].
.PP
Also if you do not specify that an encrypted event is anonymous (using
\f[C]--encrypt-anon\f[R] option in \f[B]tl-event\f[R](1) instead of
\f[C]--encrypt\f[R]), the encryption will be always direct, unless
\f[V]--encrypt-anon\f[R] option in \f[B]tl-event\f[R](1) instead of
\f[V]--encrypt\f[R]), the encryption will be always direct, unless
\f[I]crypto.always-anon\f[R] configuration value was set to true.
.PP
The encrypted kind event contains also a BASE64 encoded cryptogram
produced by \f[B]gpg\f[R](1).
The encrypted details of a successfully decrypted message can be see
using \f[C]event info\f[R] command.
using \f[V]event info\f[R] command.
.PP
Also, if \f[I]account.encrypt-to-me\f[R] is set to true (by default),
timeline will also post the same payload encrypted to yourself (in
Expand All @@ -170,9 +184,10 @@ decrypted and new event with the content of the payload is processed.
.PP
\f[B]NOTE\f[R] In fact, an encrypted message is more like an encrypted
event, that means that the decrypted payload contains another event,
like a (plain) post, tag\&... But also is possible to encrypt a already
encrypted payload, and timeline just run the decryption process twice,
or more times if required.
like a (plain) post, tag\&...
But also is possible to encrypt a already encrypted payload, and
timeline just run the decryption process twice, or more times if
required.
By design the \f[B]tl\f[R](1) command does not allow you to encrypt more
than one time, but it should be possible in theory.
.PP
Expand All @@ -196,7 +211,7 @@ so you need to verify the other\[cq]s key by hand.
.PP
If you want to use an external keyring it\[cq]s possible just setting
the configuration value \f[I]account.<account_name>.keyring\f[R] to the
path of your keyring (usually \f[C]\[ti]/.gnupg\f[R]).
path of your keyring (usually \f[V]\[ti]/.gnupg\f[R]).
This configuration value must be set by account for security reasons,
you cannot set a global \f[I]account.keyring\f[R].
Finally you must set your default keys using the commands \f[I]account
Expand All @@ -214,8 +229,8 @@ rebuild\f[R].
\f[I]account.<account_name>.encrkey\f[R], \f[I]account.<account_name>.signkey\f[R]
Contains the Key ID of the keys used to encrypt and to sign for the
specific account.
\f[B]DO NOT CHANGE THIS VALUE BY HAND. USE tl account encrkey OR tl
account signkey INSTEAD\f[R].
\f[B]DO NOT CHANGE THIS VALUE BY HAND.
USE tl account encrkey OR tl account signkey INSTEAD\f[R].
.TP
\f[I]account.encrypt-to-me\f[R]=\f[I]true\f[R]
If set to \f[I]true\f[R] (by default) also generate a new encrypted
Expand All @@ -224,7 +239,7 @@ message for yourself for any encrypted message that you post (read
.TP
\f[I]crypto.gnupg-binary\f[R]=\f[I]gpg\f[R]
Set the path to the \f[B]gpg\f[R](1) binary to use, by default try to
find it from \f[C]$PATH\f[R].
find it from \f[V]$PATH\f[R].
.TP
\f[I]crypto.auto-import\f[R]=\f[I]true\f[R]
If set to \f[I]true\f[R] (the default) timeline will import keys from
Expand Down
18 changes: 16 additions & 2 deletions man/tl-daemon.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
.\" Automatically generated by Pandoc 2.14.0.1
.\" Automatically generated by Pandoc 2.17.1.1
.\"
.TH "TL-DAEMON" "1" "2021-06-14" "Timeline v1.8-32-g96da44d" "Timeline Manual"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "TL-DAEMON" "1" "2022-06-26" "Timeline v1.8-34-gef498a0" "Timeline Manual"
.hy
.SH NAME
.PP
Expand Down
18 changes: 16 additions & 2 deletions man/tl-directory.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
.\" Automatically generated by Pandoc 2.14.0.1
.\" Automatically generated by Pandoc 2.17.1.1
.\"
.TH "TL-DIRECTORY" "1" "2021-06-14" "Timeline v1.8-32-g96da44d" "Timeline Manual"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "TL-DIRECTORY" "1" "2022-06-26" "Timeline v1.8-34-gef498a0" "Timeline Manual"
.hy
.SH NAME
.PP
Expand Down
20 changes: 17 additions & 3 deletions man/tl-event.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
.\" Automatically generated by Pandoc 2.14.0.1
.\" Automatically generated by Pandoc 2.17.1.1
.\"
.TH "TL-EVENT" "1" "2021-06-14" "Timeline v1.8-32-g96da44d" "Timeline Manual"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "TL-EVENT" "1" "2022-06-26" "Timeline v1.8-34-gef498a0" "Timeline Manual"
.hy
.SH NAME
.PP
Expand Down Expand Up @@ -31,7 +45,7 @@ A \f[B]message\f[R] could be any UTF-8 encoded text, including emojis,
or any other unicode stuff.
Additionally, you can tag your post in the same step.
Message used in post will support \f[B]ABBREVIATIONS\f[R].
If \f[C]--encrypt\f[R] or \f[C]--encrypt-anon\f[R] are present, the
If \f[V]--encrypt\f[R] or \f[V]--encrypt-anon\f[R] are present, the
event will be posted encrypted.
See \f[B]tl-crypto\f[R](7) for more information about how crypto works.
.TP
Expand Down
Loading

0 comments on commit ccd3fc3

Please sign in to comment.