Skip to content

Commit

Permalink
Add documentation for openssl-path #108
Browse files Browse the repository at this point in the history
  • Loading branch information
jmurty committed Feb 19, 2021
1 parent 222bf43 commit 7a8ce48
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ The format is based on [Keep a Changelog][1], and this project adheres to

## [Unreleased]

### Added

- Add `--openssl-path` option when initializing transcrypt to use a specific
openssl version instead of the default version found in `$PATH`. This will be
most useful to macOS users who might want to use a newer version of OpenSSL
than the one that comes included.

### Fixed

- Respect Git `core.hooksPath` setting when installing the pre-commit hook. (#104)
Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,11 @@ directory.
the password to derive the key from;
defaults to 30 random base64 characters

--openssl-path=PATH_TO_OPENSSL
use OpenSSL at this path; defaults to 'openssl' in $PATH.
To change after initialization:
git config transcrypt.openssl-path NEW_PATH

-y, --yes
assume yes and accept defaults for non-specified options

Expand Down
5 changes: 5 additions & 0 deletions man/transcrypt.1.ronn
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@ The transcrypt source code and full documentation may be downloaded from
the password to derive the key from;
defaults to 30 random base64 characters

* `--openssl-path`=<path_to_openssl>:
use OpenSSL at this path; defaults to 'openssl' in $PATH.
To change after initialization:
git config transcrypt.openssl-path NEW_PATH

* `-y`, `--yes`:
assume yes and accept defaults for non-specified options

Expand Down

0 comments on commit 7a8ce48

Please sign in to comment.