Is there locally-installable documentation?
-
I want to learn this library. I don't want to be network browsing for documentation all the time.
For one reason I don't make a practice of connecting my laptop to the Internet when I travel.
But more importantly, online documentation and user forums instead of documentation have a long history of screwing me up and causing me to waste time. Misinformation, workarounds for problems that no longer exist, stuff that's described wrong in ways that make it sound like something I'm trying to do, other outdated information, some rando talking about stuff he just doesn't know anything about, people who talk about X in ways that depend on but don't mention A through W, etc etc etc etc.... I just have real trouble sorting out the straight, brief, necessary reference information from the accumulated cruft of years of documentation and discussion that typically get left to rot on the net when documentation is "online". So, yeah, I really prefer man pages or something like them.
But the reasons don't really matter. There are no man pages for anything relating to Qt development, so... in the way of an indexed, authoritative, complete reference that doesn't go into sidetracks and accumulated cruft, what the heck is there instead? And can I install it on my laptop so it works without constantly trying to get on the damn network all the time?
-
I want to learn this library. I don't want to be network browsing for documentation all the time.
For one reason I don't make a practice of connecting my laptop to the Internet when I travel.
But more importantly, online documentation and user forums instead of documentation have a long history of screwing me up and causing me to waste time. Misinformation, workarounds for problems that no longer exist, stuff that's described wrong in ways that make it sound like something I'm trying to do, other outdated information, some rando talking about stuff he just doesn't know anything about, people who talk about X in ways that depend on but don't mention A through W, etc etc etc etc.... I just have real trouble sorting out the straight, brief, necessary reference information from the accumulated cruft of years of documentation and discussion that typically get left to rot on the net when documentation is "online". So, yeah, I really prefer man pages or something like them.
But the reasons don't really matter. There are no man pages for anything relating to Qt development, so... in the way of an indexed, authoritative, complete reference that doesn't go into sidetracks and accumulated cruft, what the heck is there instead? And can I install it on my laptop so it works without constantly trying to get on the damn network all the time?
Hi @Bear, and welcome!
There are 2 ways to access offline documentation:
- When you install Qt, you also get a copy of Qt Assistant. This is the official offline documentation browser (which is an indexed, authoritative, complete reference).
- When you code in the Qt Creator IDE, hover your mouse cursor over a class name or function, and press F1. That will open the doc panel and take you straight to the item your cursor was on. It shows you the same information as Qt Assistant.
-
Hi @Bear, and welcome!
There are 2 ways to access offline documentation:
- When you install Qt, you also get a copy of Qt Assistant. This is the official offline documentation browser (which is an indexed, authoritative, complete reference).
- When you code in the Qt Creator IDE, hover your mouse cursor over a class name or function, and press F1. That will open the doc panel and take you straight to the item your cursor was on. It shows you the same information as Qt Assistant.
Thank you.
qt5-assistant and qtcreator are things I could not see on my system and didn't know I had installed. Mostly because they have no man pages. 'apropos qt' didn't tell me a damn thing about them.
Also 'Qt\ Assistant' and 'Qt\ Creator' don't exist. 'qtcreator' I found easily enough with a guess at the real name and a whereis command. I eventually found 'qt5-assistant' by doing directory listings of all the binaries along my .path and inspecting a list of several thousand things with a mark one human eyeball. Which IMO is something civilized folk ought not need to do.
I'll shut up now. Seriously, old-phart kvetching about things being installed but invisible aside, thank you for the clues.
