C++ man pages

Today I stumbled upon across a project called cppman 1, which I believe has a very suggestive name indeed.

Manual pages for the C programming language are almost always available on Unix systems. Don’t you remember the signature of the qsort function? No problem, a man 3 qsort will refresh your memory. What about printf? What about stdlib.h? Man won’t disappoint you.

However, what about C++ man pages? I first discovered that they weren’t available by default about three years ago. Okay, so what do I do? A simple google search will probably lead you to Stack Overflow2.

At the aforementioned time, there weren’t really useful answers in there. Okay, some of them pointed out to libstd++ docs, but using them wasn’t much convenient. The best documentation sources you could find were cplusplus.com and cppreference wiki3.

You can live with these on-line references, but you will quickly get bored with them. Now, back to cppman, the boredom killer and time saver.

cppman – quick reference

Installing it

  • If you’re an user of Arch Linux, it is available in the AUR at the time I’m writing this post.
  • Otherwise, you can install it using python’s pip – ya know, pip install cppman.

It doesn’t really matter the method you choose, just make sure to add it to your PATH.

Using it

cppman sort
cppman map

Don’t cry, it is real. You can optionally cache all of its man pages, but I don’t find this strictly necessary for me. The default option (no cache) downloads manual pages on-demand.

Oh, it uses vim as its default pager, so you can search for keywords with /.

Also, hyperlinks are everywhere, so you can use K or C-] to follow them. To go back, use C-t.

By the way, it is compatible with man, so if you decide to cache its man pages, you can view them later with man (instead of cppman).

Happy hacking reading!4

Footnotes:

1

cppman – you don’t need to read the whole article; if you’re in a hurry, just open the project page and forget me!

2

As always, huh? Link.

3

The last one is by far much better maintained.

4

Wait, since when reading manual pages is a source of happiness?

C++ man pages

Novo blog — “ICPC Journal”

Estou começando um novo blog em http://thiagowfx.github.io/icpc-journal/.

Eis uns simples remarks:

  • Pode ser que tudo isso vire flood, sendo apenas um pretexto para aprender (e praticar) Jekyll, e ganhar mais um pouco de familiaridade com Liquid, HTML, YAML e CSS. Se isso acontecer, então ao menos terei aprendido algo útil;
  • Por outro lado, pode ser que isso vá para a frente, tornando-se (mais um) projeto pessoal durante os 2 ou 3 próximos anos (ou quem sabe mais? O futuro é tão incerto). Nesse caso, eu espero que alguém (isso inclui eu mesmo) possa aprender alguma coisa com o que eu escrever lá.
  • Lá eu utilizarei uma linguagem bem mais simples, direta e menos pessoal do que eu uso aqui (yeah, aqui tem o inferno de parênteses (mas você já sabia disso, certo?)), e isso vai fazer com que a linguagem que eu uso aqui também mude um pouco.
  • E, por último: os posts desse novo blog NÃO serão replicados nas minhas redes sociais (em geral, pois pode haver uma exceção ou outra), visto que esse é um tema bastante específico portanto, se você quiser acompanhá-lo, dê o seu jeito 😉 — favoritos, RSS, enfim. Ademais, tentarei deixar o site leve, com poucos add-ons, widgets ou outras firulas — diferente desse WordPress aqui :D.

Se eu postar aqui novamente sobre isso, provavelmente vai ser para falar sobre a minha experiência (conclusão) em relação ao Jekyll (devo dizer que estou impressionado, é uma engine bastante simples, me lembra bastante do sistema CMS do Xyne, o Xac).

Novo blog — “ICPC Journal”