Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More doc/man1 fixes #10065

Closed
wants to merge 16 commits into from
Closed

More doc/man1 fixes #10065

wants to merge 16 commits into from

Commits on Oct 7, 2019

  1. Configuration menu
    Copy the full SHA
    5d5fd24 View commit details
    Browse the repository at this point in the history
  2. Command docs: remove ellipses for '-rand'

    Ellipses were used to express that the '-rand' value can specify
    multiple files, like this:
    
        B<-rand> I<file...>
    
    Because there are conventions around ellipses, this becomes confusing,
    because '-rand file...' is normally intepreted to mean that
    '-rand file1 file2 file3' would be processed as three randomness
    files, which makes no sense.
    
    Rather than making things complicated with more elaborate syntax, we
    change it to:
    
        B<-rand> I<files>
    levitte committed Oct 7, 2019
    Configuration menu
    Copy the full SHA
    7ad15d1 View commit details
    Browse the repository at this point in the history
  3. Command docs: replacables are in italics, options always start with a…

    … dash
    
    Quite a lot of replacables were still bold, and some options were
    mentioned without a beginning dash.
    levitte committed Oct 7, 2019
    Configuration menu
    Copy the full SHA
    ba0540c View commit details
    Browse the repository at this point in the history
  4. Command docs: fix up command references

    Almost all OpenSSL commands are in reality 'openssl cmd', so make sure
    they are refered to like that and not just as the sub-command.
    
    Self-references are avoided as much as is possible, and replaced with
    "this command".  In some cases, we even avoid that with a slight
    rewrite of the sentence or paragrah they were in.  However, in the few
    cases where a self-reference is still admissible, they are done in
    bold, i.e. openssl-speed.pod references itself like this:
    
        B<openssl speed>
    
    References to other commands are done as manual links, i.e. CA.pl.pod
    references 'openssl req' like this: L<openssl-req(1)>
    
    Some commands are examples rather than references; we enclose those in
    C<>.
    
    While we are it, we abolish "utility", replacing it with "command", or
    remove it entirely in some cases.
    levitte committed Oct 7, 2019
    Configuration menu
    Copy the full SHA
    3e6524b View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    9f726da View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    2e75931 View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    71b56ad View commit details
    Browse the repository at this point in the history
  8. Command docs: fix some engine references

    "gost" was called "ccgost".
    "rsax" was treated like literal input rather than an engine name.
    levitte committed Oct 7, 2019
    Configuration menu
    Copy the full SHA
    1f7d01c View commit details
    Browse the repository at this point in the history
  9. Command docs: diverse small fixes

    Better synopsis for 'openssl dgst' and 'openssl enc', correct names
    for 'openssl rehash' ('c_rehash' is mentioned there too), correct
    option end marker for 'openssl verify', and finally, refer to
    sub-commands as sub-commands.
    levitte committed Oct 7, 2019
    Configuration menu
    Copy the full SHA
    3d9a83b View commit details
    Browse the repository at this point in the history
  10. Command docs: rename openssl-tsget.pod to tsget.pod, and fix it

    Make replacables italic, change '-rand' to '-r', fix links.
    levitte committed Oct 7, 2019
    Configuration menu
    Copy the full SHA
    c985d7b View commit details
    Browse the repository at this point in the history
  11. Command docs: more reference fixes

    Normalise on L<openssl-cmd(1)> over L<cmd(1)>
    levitte committed Oct 7, 2019
    Configuration menu
    Copy the full SHA
    e418d84 View commit details
    Browse the repository at this point in the history
  12. util/find-doc-nits: ignore tsget.pod name

    It's a separate script, not an openssl sub-command
    levitte committed Oct 7, 2019
    Configuration menu
    Copy the full SHA
    3effa64 View commit details
    Browse the repository at this point in the history

Commits on Oct 8, 2019

  1. Configuration menu
    Copy the full SHA
    50188fd View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    0e434ad View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    ed92eb9 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    d707ac9 View commit details
    Browse the repository at this point in the history