diff options
| author | Rich Salz <rsalz@akamai.com> | 2021-08-16 17:31:59 -0400 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2021-09-07 15:23:59 +0200 |
| commit | a4ffb33ea8b7bcf04b8181dafce7ac512081d0ab (patch) | |
| tree | 3878969c8cf65f3b061ad059920cdf6f030d4cea /INSTALL.md | |
| parent | a8d9bd8114510d3a1708da3922f07e7f707674bc (diff) | |
Use '[option...]' not '[[ options ]]' in text
Looks more like manpage format. :)
Also remove `{{..}}` notation and rewrite around it.
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/16329)
Diffstat (limited to 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 33 |
1 files changed, 12 insertions, 21 deletions
diff --git a/INSTALL.md b/INSTALL.md index 5d53cef1aa..70eb8da1ed 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -120,21 +120,11 @@ represents one of the four commands Arguments --------- -**Mandatory arguments** are enclosed in double curly braces. -A simple example would be +**Optional Arguments** are enclosed in square brackets. - $ type {{ filename }} + [option...] -which is to be understood to use the command `type` on some file name -determined by the user. - -**Optional Arguments** are enclosed in double square brackets. - - [[ options ]] - -Note that the notation assumes spaces around `{`, `}`, `[`, `]`, `{{`, `}}` and -`[[`, `]]`. This is to differentiate from OpenVMS directory -specifications, which also use [ and ], but without spaces. +A trailing ellipsis means that more than one could be specified. Quick Installation Guide ======================== @@ -1155,15 +1145,15 @@ the same. #### Unix / Linux / macOS - $ ./Configure [[ options ]] + $ ./Configure [options...] #### OpenVMS - $ perl Configure [[ options ]] + $ perl Configure [options...] #### Windows - $ perl Configure [[ options ]] + $ perl Configure [options...] ### Manual Configuration @@ -1185,12 +1175,13 @@ When you have identified your system (and if necessary compiler) use this name as the argument to `Configure`. For example, a `linux-elf` user would run: - $ ./Configure linux-elf [[ options ]] + $ ./Configure linux-elf [options...] ### Creating your own Configuration If your system isn't listed, you will have to create a configuration -file named `Configurations/{{ something }}.conf` and add the correct +file named `Configurations/YOURFILENAME.conf` (replace `YOURFILENAME` +with a filename of your choosing) and add the correct configuration for your system. See the available configs as examples and read [Configurations/README.md](Configurations/README.md) and [Configurations/README-design.md](Configurations/README-design.md) @@ -1214,21 +1205,21 @@ directory and invoking the configuration commands from there. $ mkdir /var/tmp/openssl-build $ cd /var/tmp/openssl-build - $ /PATH/TO/OPENSSL/SOURCE/Configure [[ options ]] + $ /PATH/TO/OPENSSL/SOURCE/Configure [options...] #### OpenVMS example $ set default sys$login: $ create/dir [.tmp.openssl-build] $ set default [.tmp.openssl-build] - $ perl D:[PATH.TO.OPENSSL.SOURCE]Configure [[ options ]] + $ perl D:[PATH.TO.OPENSSL.SOURCE]Configure [options...] #### Windows example $ C: $ mkdir \temp-openssl $ cd \temp-openssl - $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure [[ options ]] + $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure [options...] Paths can be relative just as well as absolute. `Configure` will do its best to translate them to relative paths whenever possible. |