$ man std::ref
No manual entry for std::ref

while

$ man -k std::ref
std::ref,std::cref(3), std::ref(3), std::cref(3) - std::ref,std::cref
std::reference_wrapper(3) - std::reference_wrapper
std::reference_wrapper::get,std::reference_wrapper::operatorT&(3), std::reference_wrapper::get(3), std::reference_wrapper::operatorT&(3) - std::reference_wrapper::get,std::reference_wrapper::operatorT&
std::reference_wrapper::operator()(3) - std::reference_wrapper::operator()
std::reference_wrapper::operator=(3) - std::reference_wrapper::operator=
std::reference_wrapper::reference_wrapper(3) - std::reference_wrapper::reference_wrapper

The following works:

$ man std::ref,std::cref

• remove the 'rm -f Makefile' line: the sed line that follows that line truncates the file if it exists and creates it if it doesn't. there is no need to remove the file prior.

• remove functions log_start() and log_end(): these functions are not used.

Update man pages to the latest version of the offline book. Please feel free to let me know if there is anything else to be done. Thanks for your really useful project.

Hi, i have a problem when using stdman. I can only get man page of the class, and get "no manual entry" message for all the member functions.

~$ man std::string::c_str
No manual entry for std::string::c_str

I refered to issue #22, and followed the Troubleshooting in README file. still can not get it work. Could you help to check it?

• os

~$ lsb_release -a
No LSB modules are available.
Distributor ID:	Ubuntu
Description:	Ubuntu 16.04.2 LTS
Release:	16.04
Codename:	xenial

• the last few lines of man std::string
• files in install dir

~$ ls -ltr /usr/local/share/man/man3 | grep "std::string"
-rw-r--r-- 1 root root  534 Apr 11 22:04 std::hash(std::string_view,std::wstring_view,std::u16string_view,std::u32string_view).3.gz
-rw-r--r-- 1 root root  767 Apr 11 22:04 std::hash(std::string,std::wstring,std::u16string,std::u32string,std::pmr::string,.3.gz
-rw-r--r-- 1 root root 2603 Apr 11 22:04 std::string.3.gz
-rw-r--r-- 1 root root 2946 Apr 11 22:04 std::stringstream.3.gz
-rw-r--r-- 1 root root 2195 Apr 11 22:04 std::stringbuf.3.gz
-rw-r--r-- 1 root root  529 Apr 11 22:04 std::stringstream::operator=.3.gz
-rw-r--r-- 1 root root  319 Apr 11 22:04 std::stringstream::rdbuf.3.gz
-rw-r--r-- 1 root root  464 Apr 11 22:04 std::stringstream::swap.3.gz

• configure in .bashrc

~$ cat ~/.bashrc | tail -n 2
export MANPAGER="/bin/sh -c \"col -b | vim -c 'set ft=man ts=8 nomod nolist nonu noma' -\""
export MANPATH=/usr/local/man:/usr/local/share/man:/usr/share/man:/usr/man

I saw the gif that pressing std::string:: + tab will show all std::string's sub function, but it didn't show anything. output is as follows:

man std::string:: 
No manual entry for std::string::

os : linux centos6.2

Man pages are regenerated with the HTML books from the unofficial source (mentioned by the cppreferece) and not the official one. The reason is that, the latest official release dates back to June 2019!

Notes from the release:

v20201016 Latest

• Update content from the website.
• Remove new ads (BuySellAds)

One problem with the generated files was that, there were a lot of trailing blanks in them. So I removed them with:

 find man ! -type d -exec sed -i'' 's/[[:blank:]]*$//' {} \;

Hopefully, that didn't create any unwanted result.

Cpprefenre have changed their wiki to add template in header part: Previous format:

std::basic_string::find

Current format:

std::basic_string<CharT,Traits,Allocator>::find

To remove the template with regex will fix the current break

Thank you very much for providing this converter!

I've found a minor issue here: the command apropos (aka man -k) uses a "whatis" database built using the command mandb to show a list of manual pages matching a given keyword (at least on Linux).

The program mandb fails to extract the expected information from the CPPreference manpages because they do not have a "NAME" section.

The following patch fixes this:

diff --git a/src/groff.hpp b/src/groff.hpp
index 1554a62..db1d41a 100644
--- a/src/groff.hpp
+++ b/src/groff.hpp
@@ -39,7 +39,9 @@ class groff
       /* First two lines are always the same. */
       state.lines[0] = ".TH " + name + " 3 "
                        "\"" + state.creation_date + "\" \"" + state.version + " | http://cppreference.com\" "
-                       "\"C++ Standard Libary\"";
+                       "\"C++ Standard Libary\""
+                       "\n" ".SH NAME\n" +
+                        name + " \\- " + name + "\n" ;
       state.lines[1] = "Synopsis";

       groff_detail::section(state.lines);

Note that I simply use the name of the method as its description. It's very rough, maybe there is a way to extract a one-line description from the text.

./configure --datarootdir $HOME/tmp/stdman/root/ --mandir $HOME/tmp/stdman/root/man
Configuring stdman
Platform: Linux

Reference location: ./reference/en/cpp
Install prefix: /usr/local
Install data prefix: /usr/local/share
Install man prefix: /usr/local/share/man
Temporary man location: ./man
Generation will be on 8 threads

Populating Makefile
Done configuring stdman

To install, use `sudo make install`

Passing -p to install will preserve the timestamps from the original files. This helps ensure that builds from the same source are reproducible [1].

Tested with both BSD and GNU install [2, 3], so this will work on both macOS and Linux.

[1] See https://reproducible-builds.org. [2] https://man7.org/linux/man-pages/man1/install.1.html [3] https://www.freebsd.org/cgi/man.cgi?query=install

v20220201

Man pages are regenerated with the HTML books from the unofficial source 1 (mentioned by the cppreferece.com in their website2) and not the official one.

Release Notes

v20220201

• Update content from the website.

Build Process

Here's is the details of build process, for those who may want to contribute:

• Note that, this build has been done on a Macbook Air M1. the prerequisites for this build are:
  • findutils
  • gsed
  • elinks

1. fork, clone and create a branch

git clone [email protected]/<username>/stdman && cd $_
git switch -C update/v20220201

2. download the latest html-book and extract it

wget -c https://github.com/PeterFeicht/cppreference-doc/releases/download/v20220201/html-book-20220201.zip
unzip html-book-20220201.zip -d html-book

3. create a directory for reference html files and mv html files to thre

mkdir -p reference/en/
mv html-books/reference/en/cpp/ reference/en/

4. configure and generate man pages

./configure --reference=./reference/en/cpp
make generate

5. install and test man pages (check the date at the end of a man page)

sudo make install
sudo /usr/libexec/locate.updatedb (macos)
man std::wstringstream

6. remove trailing whitespace from generated man pages

gfind man | xargs -I{} gsed -i'' 's/[[:blank:]]*$//' {} # macos
find man | xargs -I{} sed -i'' 's/[[:blank:]]*$//' {} # gnu

7. stage changes, clean untracked files and push changes to remote

git add -u && git clean -xfd
git commit && git push origin update/v20220201

I've noticed that some manpages have non-printing characters in them; for instance, std::rand has this line (should be 0):

https://github.com/jeaye/stdman/blob/478d353c73bec79bbbad833a31c50eecd4578b46/man/std::rand.3#L9

According to grep, there's around 200 files that have the characters, which, comparing to the website versions, seem to almost always be characters in <span> tags, such as 0, a ;, a (, or whitespace, like the below:

1. whitespace (I think) https://github.com/jeaye/stdman/blob/478d353c73bec79bbbad833a31c50eecd4578b46/man/std::accumulate.3#L42

2. ; https://github.com/jeaye/stdman/blob/478d353c73bec79bbbad833a31c50eecd4578b46/man/std::condition_variable::wait_until.3#L66

3. ( https://github.com/jeaye/stdman/blob/478d353c73bec79bbbad833a31c50eecd4578b46/man/std::iterator_traits.3#L71

Some unicode characters also don't seem to be handled correctly:

https://github.com/jeaye/stdman/blob/478d353c73bec79bbbad833a31c50eecd4578b46/man/std::islower(std::locale).3#L43

It'd be nice if all of these could be parsed and rendered properly.

<code>...</code> is still there. I'm not sure this tag should be automatically handled by asciidoctor, if so it should be some option to fully clean it up I guess.

At any rate, it would be great to clean this tag up.

PS. I'm using release tag 2018.03.11 if using latest commit, generated man page files' filename *.3 will also include template argument like std::something<Arg1,Arg2>:: .... (that is for another issue).

I install this by Homebrew at mac. brew install stdman and find the problem as title describes.

I restart Terminal.app but still find it not work.

Thanks in advance.

When I opened man page for std::normal_distribution I found out that the equation is not displayed correctly. It looks like this: f(x; μ,σ) =

              1
              σ
              √
              2π

              exp⎛
              ⎜
              ⎝

              -1
              2

              ⎛
              ⎜
              ⎝

              x-μ
              σ

              ⎞
              ⎟
              ⎠2
              ⎞
              ⎟
              ⎠

and it should be all in one line.

Formatting of synopsis section of man std::async is messed up to the point of being undecipherable, no matter what terminal window height I try.

It most certainly has to do with the complex table format in use at http://en.cppreference.com/w/cpp/thread/async