Post History

50%

+0 −0

Q&A How to open documentation in qch format in Debian based systems?

Install Qt Assistant (either 5 or 6 works): apt install qt5-assistant This might be already installed, the package in the question does depend on it but for some reason qt5-doc does not, i...

posted 5mo ago by Quasímodo‭ · edited 5mo ago by Quasímodo‭

Answer

#2: Post edited by

Quasímodo‭ · 2024-06-16T18:09:14Z (5 months ago)
qtchooser is not the required package, it is qt*-assistant.

Copy Link

Raw

Markdown

~~- Install `qtchooser`:~~
~~apt install qtchooser~~
- Option 1: Load it with the CLI
- Register the help file in the Qt Assistant:
assistant -register /usr/share/cppreference/doc/qch/cppreference-doc-en-cpp.qch
It should output "Documentation successfully registered."
- Open the Qt Assistant:
assistant
- Option 2: Load it with the GUI
- Open the Qt Assistant:
assistant
- In the window that opens, go to `Edit > Preferences > Documentation > Add`.
- In the file chooser dialogue box that opens, choose the qch file you want to view, i.e. `/usr/share/cppreference/doc/qch/cppreference-doc-en-cpp.qch`.
- The program may take some time to update the search index; This will be indicated by a loading bar in the bottom right corner.
- The documentation is now available through the program, you can select in the contents pane as depicted below or just search the index.
![Documentation of std::basic_string in the Qt Assistant](https://linux.codidact.com/uploads/0a7urh5vkuxjbumwa58nmjpvqjp5)
~~Tested with Qt Assistant 5.15.13.~~

- Install Qt Assistant (either 5 or 6 works):
apt install qt5-assistant
This might be already installed, the package in the question does depend on it but for some reason `qt5-doc` does not, it only recommends it.
- Option 1: Load it with the CLI
- Register the help file in the Qt Assistant:
assistant -register /usr/share/cppreference/doc/qch/cppreference-doc-en-cpp.qch
It should output "Documentation successfully registered."
- Open the Qt Assistant:
assistant
- Option 2: Load it with the GUI
- Open the Qt Assistant:
assistant
- In the window that opens, go to `Edit > Preferences > Documentation > Add`.
- In the file chooser dialogue box that opens, choose the qch file you want to view, i.e. `/usr/share/cppreference/doc/qch/cppreference-doc-en-cpp.qch`.
- The program may take some time to update the search index; This will be indicated by a loading bar in the bottom right corner.
- The documentation is now available through the program, you can select in the contents pane as depicted below or just search the index.
![Documentation of std::basic_string in the Qt Assistant](https://linux.codidact.com/uploads/0a7urh5vkuxjbumwa58nmjpvqjp5)
Tested with Qt Assistant 5.15.13.

#1: Initial revision by

Quasímodo‭ · 2024-06-16T17:11:21Z (5 months ago)

Copy Link

Raw

Markdown

- Install `qtchooser`:
 
       apt install qtchooser

- Option 1: Load it with the CLI

  - Register the help file in the Qt Assistant:

         assistant -register /usr/share/cppreference/doc/qch/cppreference-doc-en-cpp.qch

      It should output "Documentation successfully registered."

   - Open the Qt Assistant:

          assistant

- Option 2: Load it with the GUI

  - Open the Qt Assistant:

         assistant

  - In the window that opens, go to `Edit > Preferences > Documentation > Add`.

  - In the file chooser dialogue box that opens, choose the qch file you want to view, i.e. `/usr/share/cppreference/doc/qch/cppreference-doc-en-cpp.qch`.

- The program may take some time to update the search index; This will be indicated by a loading bar in the bottom right corner.

- The documentation is now available through the program, you can select in the contents pane as depicted below or just search the index.

![Documentation of std::basic_string in the Qt Assistant](https://linux.codidact.com/uploads/0a7urh5vkuxjbumwa58nmjpvqjp5)

Tested with Qt Assistant 5.15.13.

Communities

Post History