Official documentation page

[Birdie0]

Hi, is there official documentation page website somewhere? I only could find https://www.funtoo.org/Funtoo:Keychain but it doesn't mention much of new stuff like fish shell support and etc.

[danielrobbins]

For keychain 3, documentation is built-in and can be viewed with "keychain man" and "keychain man --list" for all topics. This is also keychain --help and keychain --help, and you can type in any command and add an --explain and it will give you excerpts from the docs to help you understand that command-line.

I do need to get some references online soon, and the docs are a WIP for the beta.

[NikosAlexandris]

@danielrobbins not directly about the documentation page : the table at https://github.com/danielrobbins/keychain#the-keychain-difference explains the "why" on-sight.

┌─────────────────────────────────────────────────────────────┐
│  Without Keychain:                                          │
│                                                             │
│  Terminal 1 → ssh-agent (prompt)                            │
│  Terminal 2 → ssh-agent (prompt again)                      │
│  Terminal 3 → ssh-agent (prompt again)                      │
│  Cron job → no agent (fails)                                │
└─────────────────────────────────────────────────────────────┘

┌─────────────────────────────────────────────────────────────┐
│  With Keychain:                                             │
│                                                             │
│  Terminal 1 ─┐                                              │
│  Terminal 2 ─┼→ single ssh-agent (prompt once)              │
│  Terminal 3 ─┤    ↓                                         │
│  Cron job ───┘    all terminals reconnect automatically     │
└─────────────────────────────────────────────────────────────┘

Maybe worth be put higher up in the README.md and then somewhere in the beginning in the new documentation too.

[danielrobbins]

@NikosAlexandris thanks for the suggestion. I agree -- this is a good explanation and should be higher up in the README.md, and also be in the new docs.