Re: [openssl-users] openssl 1.1.1 manuals
Great idea; https://github.com/openssl/web/issues/101 On 12/28/18, 12:39 AM, "Jakob Bohm via openssl-users" wrote: Consider at least including the one-line manpage summaries on the index pages (the ones displayed by the apropos command on POSIX systems). -- openssl-users mailing list To unsubscribe: https://mta.openssl.org/mailman/listinfo/openssl-users
Re: [openssl-users] openssl 1.1.1 manuals
On 27/12/2018 20:39, Dr. Matthias St. Pierre wrote:
Particularly if you don't know exactly what one is looking for...
{ There is something amiss with BIO_addr_rawaddress... it's shift right.
I don't see a problem in the HTML source though.. }
Sure, google will find some things, but usually it's the wrong version, and
one has to guess what the URL for the most recent one is.
At which point, like Dennis Clarke suggests, might as well grep the POD files
in the source code. This is not terribly effective to find information
about how to manipulate particular object types.
(I have started writing an index by object type for my own use, but I doubt
I'll get very far)
The manpages are primarily what the name says: manual pages. I.e, their
primary use is the unix/linux 'man' command.
The conversion to html is an add-on to make it available via web server.
And I agree with you that static web pages are not of much help, it could
be better, more searchable.
Consider at least including the one-line manpage summaries on the index
pages (the ones displayed by the apropos command on POSIX systems).
Enjoy
Jakob
--
Jakob Bohm, CIO, Partner, WiseMo A/S. https://www.wisemo.com
Transformervej 29, 2860 Søborg, Denmark. Direct +45 31 13 16 10
This public discussion message is non-binding and may contain errors.
WiseMo - Remote Service Management for PCs, Phones and Embedded
--
openssl-users mailing list
To unsubscribe: https://mta.openssl.org/mailman/listinfo/openssl-users
Re: [openssl-users] openssl 1.1.1 manuals
> The docs site is screwed up. Actually, it is screwed up for the older versions, not for 1.1.1: In OpenSSL 1.1.0 and before, the pod files (the manual page sources) would be located in /doc/crypto and /doc/ssl, and only during the installation would be placed in the proper manX subdirectory (X=1,3,5,7). Starting with OpenSSL 1.1.1, the pod files are now reorganized in subdirectories doc/man1, doc/man3, doc/man5, doc/man7, reflecting the manual section where they will finally be installed. So the path is correct for 1.1.1 and screwed up for 1.1.0 and below. https://www.openssl.org/docs/man1.1.1/man3/CMS_sign.html https://www.openssl.org/docs/man1.1.0/crypto/CMS_sign.html Matthias -- openssl-users mailing list To unsubscribe: https://mta.openssl.org/mailman/listinfo/openssl-users
Re: [openssl-users] openssl 1.1.1 manuals
> Particularly if you don't know exactly what one is looking for...
> { There is something amiss with BIO_addr_rawaddress... it's shift right.
> I don't see a problem in the HTML source though.. }
>
> Sure, google will find some things, but usually it's the wrong version, and
> one has to guess what the URL for the most recent one is.
>
> At which point, like Dennis Clarke suggests, might as well grep the POD files
> in the source code. This is not terribly effective to find information
> about how to manipulate particular object types.
>
> (I have started writing an index by object type for my own use, but I doubt
> I'll get very far)
The manpages are primarily what the name says: manual pages. I.e, their
primary use is the unix/linux 'man' command.
The conversion to html is an add-on to make it available via web server.
And I agree with you that static web pages are not of much help, it could
be better, more searchable.
As for grepping the POD files: There is a much simpler solution if you are using
bash on linux: Install your manual pages locally, add them to your MANPATH, and
marvel at the power of bash's tab completion.
Disclaimer: Unless you know what you are doing, you should not replace your
distribution's copy of OpenSSL by your own, but instead install it to a separate
location. For example, I have all my openssl library versions installed locally
in
/opt/openssl-dev
/opt/openssl-1.1.1-dev
/opt/openssl-1.1.0-dev
/opt/openssl-1.0.2-dev
(By configuring with --prefix=/opt/openssl-dev (etc.) and then running
'make -j 16 ; sudo make install'.)
Additionally, I have a simple script and a set of aliases 'ossl', 'ossl111'
to set the MANPATH accordingly:
cat ~/.osslpath
export PATH=${OSSLPATH}/bin:$ORI_PATH
export LD_LIBRARY_PATH=${OSSLPATH}/lib:$ORI_LD_LIBRARY_PATH
export MANPATH=${OSSLPATH}/${OSSL_MANPATH}:$ORI_MANPATH
msp@msppc:~$ alias ossl
alias ossl='export OSSLPATH=/opt/openssl-dev ; OSSL_MANPATH=share/man
source ~/.osslpath ; echo $OSSLPATH: $(openssl version)'
msp@msppc:~$ alias ossl111
alias ossl111='export OSSLPATH=/opt/openssl-1.1.1-dev ;
OSSL_MANPATH=share/man source ~/.osslpath ; echo $OSSLPATH: $(openssl version)'
($ORI_PATH is initally set to $PATH in my .bashrc, and the same holds for the
other $ORI_XXX)
Changing to the manual pages for the correct openssl version is now a matter of
a single command,
msp@msppc:~$ ossl
/opt/openssl-dev: OpenSSL 3.0.0-dev xx XXX
And voila, if your tab completion is setup correctly, help is only two s
away:
msp@msppc:~$ man BIO_new
BIO_new BIO_new_file
BIO_new_CMS BIO_new_fp
BIO_new_accept BIO_new_mem_buf
BIO_new_bio_pairBIO_new_socket
BIO_new_buffer_ssl_connect BIO_new_ssl
BIO_new_connect BIO_new_ssl_connect
BIO_new_fd
Matthias
--
openssl-users mailing list
To unsubscribe: https://mta.openssl.org/mailman/listinfo/openssl-users
Re: [openssl-users] openssl 1.1.1 manuals
Dr. Matthias St. Pierre wrote:
>> Generally I find everything I need in the source tarball and after the
>> install is done everything anyone could want is installed on the
>> system. As for 'sidenav' that sounds like someone actually has to go
>> tweak stuff manually on some website. Sadly. Anyways, the source
>> tarballs have everything that is for certain. A lot of symlinks to be
>> sure.
>>
>> Dennis
> All supported manual page versions are publicly available from this
> site here. https://www.openssl.org/docs/manpages.html
The listings like:
https://www.openssl.org/docs/man1.1.1/man3/
are basically useless for navigation.
Particularly if you don't know exactly what one is looking for...
{ There is something amiss with BIO_addr_rawaddress... it's shift right.
I don't see a problem in the HTML source though.. }
Sure, google will find some things, but usually it's the wrong version, and
one has to guess what the URL for the most recent one is.
At which point, like Dennis Clarke suggests, might as well grep the POD files
in the source code. This is not terribly effective to find information
about how to manipulate particular object types.
(I have started writing an index by object type for my own use, but I doubt
I'll get very far)
--
] Never tell me the odds! | ipv6 mesh networks [
] Michael Richardson, Sandelman Software Works|IoT architect [
] m...@sandelman.ca http://www.sandelman.ca/| ruby on rails[
signature.asc
Description: PGP signature
--
openssl-users mailing list
To unsubscribe: https://mta.openssl.org/mailman/listinfo/openssl-users
Re: [openssl-users] openssl 1.1.1 manuals
The docs site is screwed up. CMS_sign is indeed documented for 1.1.1 - but you have to go there via https://www.openssl.org/docs/man1.1.1 -> Libraries -> CMS_sign.html, which would bring you to https://www.openssl.org/docs/man1.1.1/man3/CMS_sign.html On 12/27/18, 14:00, "openssl-users on behalf of Michael Richardson" wrote: J. J. Farrell wrote: > man1.1.1 looks OK to me, the pages all appear to be there. What is > missing is a link to 1.1.1 in the little Manpages list of links on the > right hand side of the page https://www.openssl.org/docs/man1.1.0/crypto/CMS_sign.html exists, but https://www.openssl.org/docs/man1.1.1/crypto/CMS_sign.html does not. There are other examples which I have come across. > On 27/12/2018 16:31, Michael Richardson wrote: > If manual pages for 1.1.1 aren't going to be posted/generated: > could https://www.openssl.org/docs/man1.1.1 redirect to > https://www.openssl.org/docs/man1.1.0? > (I think that 1.1.1 ought to be generated) > -- > J. J. Farrell Not speaking for Oracle > > Alternatives: > > -- > openssl-users mailing list To unsubscribe: > https://mta.openssl.org/mailman/listinfo/openssl-users -- openssl-users mailing list To unsubscribe: https://mta.openssl.org/mailman/listinfo/openssl-users smime.p7s Description: S/MIME cryptographic signature -- openssl-users mailing list To unsubscribe: https://mta.openssl.org/mailman/listinfo/openssl-users
Re: [openssl-users] openssl 1.1.1 manuals
J. J. Farrell wrote: > man1.1.1 looks OK to me, the pages all appear to be there. What is > missing is a link to 1.1.1 in the little Manpages list of links on the > right hand side of the page https://www.openssl.org/docs/man1.1.0/crypto/CMS_sign.html exists, but https://www.openssl.org/docs/man1.1.1/crypto/CMS_sign.html does not. There are other examples which I have come across. > On 27/12/2018 16:31, Michael Richardson wrote: > If manual pages for 1.1.1 aren't going to be posted/generated: > could https://www.openssl.org/docs/man1.1.1 redirect to > https://www.openssl.org/docs/man1.1.0? > (I think that 1.1.1 ought to be generated) > -- > J. J. Farrell Not speaking for Oracle > > Alternatives: > > -- > openssl-users mailing list To unsubscribe: > https://mta.openssl.org/mailman/listinfo/openssl-users -- openssl-users mailing list To unsubscribe: https://mta.openssl.org/mailman/listinfo/openssl-users
Re: [openssl-users] openssl 1.1.1 manuals
> Generally I find everything I need in the source tarball and after the > install is done everything anyone could want is installed on the system. > As for 'sidenav' that sounds like someone actually has to go tweak stuff > manually on some website. Sadly. Anyways, the source tarballs have > everything that is for certain. A lot of symlinks to be sure. > > Dennis All supported manual page versions are publicly available from this site here. https://www.openssl.org/docs/manpages.html The missing link in the manual side bar is an oversight, which will be fixed shortly, see https://github.com/openssl/web/pull/100 HTH, Matthias -- openssl-users mailing list To unsubscribe: https://mta.openssl.org/mailman/listinfo/openssl-users
Re: [openssl-users] openssl 1.1.1 manuals
On 12/27/18 11:48 AM, Salz, Rich via openssl-users wrote: They are there, but the sidenav needs to be updated. Generally I find everything I need in the source tarball and after the install is done everything anyone could want is installed on the system. As for 'sidenav' that sounds like someone actually has to go tweak stuff manually on some website. Sadly. Anyways, the source tarballs have everything that is for certain. A lot of symlinks to be sure. Dennis -- openssl-users mailing list To unsubscribe: https://mta.openssl.org/mailman/listinfo/openssl-users
Re: [openssl-users] openssl 1.1.1 manuals
They are there, but the sidenav needs to be updated. On 12/27/18, 11:31 AM, "Michael Richardson" wrote: If manual pages for 1.1.1 aren't going to be posted/generated: could https://www.openssl.org/docs/man1.1.1 redirect to https://www.openssl.org/docs/man1.1.0? (I think that 1.1.1 ought to be generated) -- ] Never tell me the odds! | ipv6 mesh networks [ ] Michael Richardson, Sandelman Software Works|IoT architect [ ] m...@sandelman.ca http://www.sandelman.ca/| ruby on rails [ -- openssl-users mailing list To unsubscribe: https://mta.openssl.org/mailman/listinfo/openssl-users
Re: [openssl-users] openssl 1.1.1 manuals
man1.1.1 looks OK to me, the pages all appear to be there. What is missing is a link to 1.1.1 in the little Manpages list of links on the right hand side of the page On 27/12/2018 16:31, Michael Richardson wrote: If manual pages for 1.1.1 aren't going to be posted/generated: could https://www.openssl.org/docs/man1.1.1 redirect to https://www.openssl.org/docs/man1.1.0? (I think that 1.1.1 ought to be generated) -- J. J. Farrell Not speaking for Oracle -- openssl-users mailing list To unsubscribe: https://mta.openssl.org/mailman/listinfo/openssl-users
[openssl-users] openssl 1.1.1 manuals
If manual pages for 1.1.1 aren't going to be posted/generated: could https://www.openssl.org/docs/man1.1.1 redirect to https://www.openssl.org/docs/man1.1.0? (I think that 1.1.1 ought to be generated) -- ] Never tell me the odds! | ipv6 mesh networks [ ] Michael Richardson, Sandelman Software Works|IoT architect [ ] m...@sandelman.ca http://www.sandelman.ca/| ruby on rails[ signature.asc Description: PGP signature -- openssl-users mailing list To unsubscribe: https://mta.openssl.org/mailman/listinfo/openssl-users
