Skip to content

Commit

Permalink
DOC: nitpick docstring comment and add to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ZLLentz committed Jul 24, 2024
1 parent 1163bd8 commit be76659
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -685,6 +685,19 @@ usage: serverStat servername options<br/>
</td>
</tr>

<tr>
<td>ssh-agent-helper</td>
<td>
usage: source ssh-agent-helper<br/><br/>
Helper script for starting the ssh agent if needed and doing an ssh-add -t 12h.
This will let anyone smoothly run github/ssh related scripts without multiple password prompts.
An ssh-agent process started by using this script will be automatically closed on logout.
<br/><br/>
This script is intended to be sourced.
Sourcing this script lets ssh-agent set the proper environment variables it needs to run properly.
</td>
</tr>

<tr>
<td>startami</td>
<td>
Expand Down
4 changes: 2 additions & 2 deletions scripts/ssh-agent-helper
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/usr/bin/bash
#
# Helper script for starting the ssh agent if needed and doing an ssh-add.
# Helper script for starting the ssh agent if needed and doing an ssh-add -t 12h.
# This will let anyone smoothly run github/ssh related scripts without multiple password prompts.
# An ssh-agent instance set up using this script will be automaticalls closed on logout.
# An ssh-agent process started by using this script will be automatically closed on logout.
#
# This script is intended to be sourced.
# Sourcing this script lets ssh-agent set the proper environment variables it needs to run properly.
Expand Down

0 comments on commit be76659

Please sign in to comment.