Skip to content

Commit

Permalink
doc/api-sessions (make-session): Improve the description
Browse files Browse the repository at this point in the history
* doc/api-sessions.texi (make-session): Improve the description of "#:config"
option.
  • Loading branch information
artyom-poptsov committed Nov 5, 2024
1 parent bdffe1b commit f36f828
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions doc/api-sessions.texi
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,13 @@ List of allowed keywords:
@item config
Set the configuration file path. Note that @var{host} must be set to properly
load configuration otherwise @code{guile-ssh-error} will be thrown.

If this option is set to @code{#t} the default user configuration file
@file{~/.ssh/config} is read.

On the other hand setting it to @code{#f} value means that no configuration
file will be read (@code{process-config?} is set to @code{#f}.)

@item host
@item identity
@item knownhosts
Expand Down

0 comments on commit f36f828

Please sign in to comment.