Difference between revisions of "Cppreference:Archives"
From cppreference.com
(→Unofficial Release: Update to new version) |
|||
| (34 intermediate revisions by 16 users not shown) | |||
| Line 4: | Line 4: | ||
===Html book=== | ===Html book=== | ||
| − | |||
This html book is an offline copy of the website with unnecessary UI elements stripped out. Choose this if you just want to access cppreference.com via a browser while without internet connection. | This html book is an offline copy of the website with unnecessary UI elements stripped out. Choose this if you just want to access cppreference.com via a browser while without internet connection. | ||
{| | {| | ||
| − | | rowspan=2 style="padding-right:1em;" | 7 June 2019<br | + | |rowspan=2 style="padding-right:1em;"|7 June 2019<br>{{small|[[Cppreference:Old archives|Old versions]]}} |
| − | | [[File:html_book_20190607.zip]] | + | |[[File:html_book_20190607.zip]] |
|- | |- | ||
| − | | [[File:html_book_20190607.tar.xz]] | + | |[[File:html_book_20190607.tar.xz]] |
|} | |} | ||
===Raw archive=== | ===Raw archive=== | ||
| − | + | This archive is a raw copy created using [https://www.gnu.org/software/wget/ {{tt|wget}}] (GNU Wget). Note that this archive is not useful for viewing as-is, please use the HTML book instead. Note: the utility scripts and a makefile are contained in this package, so it can be used as full upstream source. | |
| − | This archive is a raw copy created using [ | + | |
{| | {| | ||
| − | | rowspan=2 style="padding-right:1em;" | 7 June 2019<br | + | |rowspan=2 style="padding-right:1em;"|7 June 2019<br>{{small|[[Cppreference:Old archives|Old versions]]}} |
| − | | [[File:cppreference-doc-20190607.zip]] | + | |[[File:cppreference-doc-20190607.zip]] |
|- | |- | ||
| − | | [[File:cppreference-doc-20190607.tar.xz]] | + | |[[File:cppreference-doc-20190607.tar.xz]] |
|} | |} | ||
===Unofficial Release=== | ===Unofficial Release=== | ||
| − | |||
An unofficial fork that is updated more frequently can be found in [https://github.com/PeterFeicht/cppreference-doc this] git repository. | An unofficial fork that is updated more frequently can be found in [https://github.com/PeterFeicht/cppreference-doc this] git repository. | ||
{| | {| | ||
| − | | rowspan=3 style="padding-right:1em;" | | + | |rowspan=3 style="padding-right:1em;"|10 November 2024<br>{{small|[https://github.com/PeterFeicht/cppreference-doc/releases Old versions]}} |
| − | | [https://github.com/PeterFeicht/cppreference-doc/releases/download/ | + | |[https://github.com/PeterFeicht/cppreference-doc/releases/download/v20241110/html-book-20241110.zip html-book-20241110.zip] (52MB) |
|- | |- | ||
| − | | [https://github.com/PeterFeicht/cppreference-doc/releases/download/ | + | |[https://github.com/PeterFeicht/cppreference-doc/releases/download/v20241110/html-book-20240610.tar.xz html-book-20241110.tar.xz] (6MB) |
|- | |- | ||
| − | | [https://github.com/PeterFeicht/cppreference-doc/releases/tag/ | + | |[https://github.com/PeterFeicht/cppreference-doc/releases/tag/v20241110 Other files (qch and raw archive)] |
|} | |} | ||
===Devhelp book=== | ===Devhelp book=== | ||
| − | |||
[https://wiki.gnome.org/Apps/Devhelp Devhelp] is a documentation browser for GTK/Gnome. | [https://wiki.gnome.org/Apps/Devhelp Devhelp] is a documentation browser for GTK/Gnome. | ||
| − | The book is available as {{tt|cppreference-doc-en-html}} {{tt|deb}} package in the official [https://packages.debian.org/search?keywords=cppreference&searchon=names&suite=all§ion=all Debian ] and [ | + | The book is available as {{tt|cppreference-doc-en-html}} {{tt|deb}} package in the official [https://packages.debian.org/search?keywords=cppreference&searchon=names&suite=all§ion=all Debian ] and [https://packages.ubuntu.com/search?keywords=cppreference&searchon=names&suite=all§ion=all Ubuntu] repositories. |
| − | For arch users, the package {{tt|cppreference-devhelp}} could be found [https://aur.archlinux.org/packages/cppreference-devhelp/ here], which can be installed from AUR by tools like yaourt. | + | For arch users, the package {{tt|cppreference-devhelp}} could be found [https://aur.archlinux.org/packages/cppreference-devhelp/ here], which can be installed from AUR by tools like {{tt|yaourt}}. |
===Qt help book=== | ===Qt help book=== | ||
| − | + | {{tt|qch}} is a documentation format for use in the Qt tools such as [https://wiki.qt.io/Qt_Creator QtCreator] or Qt Assistant [https://doc.qt.io/qt-5/qtassistant-index.html v5] / [https://doc.qt.io/qt-6/qtassistant-index.html v6]. | |
| − | {{tt|qch}} is a documentation format for use in the Qt tools such as [https://wiki.qt.io/Qt_Creator QtCreator] or Qt Assistant [ | + | |
The {{tt|qch}} book below contains a version of the html book, adapted for use with the Qt tools. Search also works. | The {{tt|qch}} book below contains a version of the html book, adapted for use with the Qt tools. Search also works. | ||
| Line 56: | Line 51: | ||
{| | {| | ||
|- | |- | ||
| − | | rowspan=2 style="padding-right:1em;" | 7 June 2019<br | + | |rowspan=2 style="padding-right:1em;"|7 June 2019<br>{{small|[[Cppreference:Old archives|Old versions]]}} |
| − | | [[File:qch_book_20190607.zip]] | + | |[[File:qch_book_20190607.zip]] |
|- | |- | ||
| − | | [[File:qch_book_20190607.tar.xz]] | + | |[[File:qch_book_20190607.tar.xz]] |
|} | |} | ||
| − | The book is available as {{tt|cppreference-doc-en-qch}} {{tt|deb}} package in the official [https://packages.debian.org/search?keywords=cppreference&searchon=names&suite=all§ion=all Debian ] and [ | + | The book is available as {{tt|cppreference-doc-en-qch}} {{tt|deb}} package in the official [https://packages.debian.org/search?keywords=cppreference&searchon=names&suite=all§ion=all Debian ] and [https://packages.ubuntu.com/search?keywords=cppreference&searchon=names&suite=all§ion=all Ubuntu] repositories. |
The book is also provided by AUR package [https://aur.archlinux.org/packages/cppreference-qt/ cppreference-qt] for Arch Linux users. | The book is also provided by AUR package [https://aur.archlinux.org/packages/cppreference-qt/ cppreference-qt] for Arch Linux users. | ||
===Doxygen tag file=== | ===Doxygen tag file=== | ||
| − | [ | + | [https://doxygen.org/ Doxygen] is a tool to automatically generate documentation from source code comments. It supports automatic linking of C++ names to external documentation via [https://www.doxygen.org/manual/external.html tag file] functionality. Two tag files are provided in the "html book" archive mentioned above: |
| − | + | ||
* '''local''': use the {{tt|cppreference-doxygen-local.tag.xml}} file to link to the local "html book" archive at the default install location. | * '''local''': use the {{tt|cppreference-doxygen-local.tag.xml}} file to link to the local "html book" archive at the default install location. | ||
| − | |||
* '''web''': {{tt|cppreference-doxygen-web.tag.xml}} to link directly to the cppreference.com website. | * '''web''': {{tt|cppreference-doxygen-web.tag.xml}} to link directly to the cppreference.com website. | ||
| − | |||
In order to support external cppreference documentation, Doxyfile needs to be modified as follows: | In order to support external cppreference documentation, Doxyfile needs to be modified as follows: | ||
| − | |||
* If the link target is local archive, add the following line: | * If the link target is local archive, add the following line: | ||
| − | + | : {{c|lang=text|1=TAGFILES += "location/of/cppreference-doxygen-local.tag.xml=/location/of/html/book/root/"}}. | |
| − | {{ | + | |
| − | + | ||
* If the link target is cppreference.com, add the following line: | * If the link target is cppreference.com, add the following line: | ||
| − | + | : {{c|lang=text|1=TAGFILES += "location/of/cppreference-doxygen-web.tag.xml=https://en.cppreference.com/w/"}}. | |
| − | {{ | + | |
===Manpages=== | ===Manpages=== | ||
| − | + | * [https://github.com/jeaye/stdman stdman]: automatically generated man pages. [https://github.com/jeaye/stdman#Installation Installation] notes are included in the README and updates follow the offline archive releases. Last update: 1 February 2022 (~ 4.7 MB). | |
| − | + | * [https://github.com/aitjcize/cppman cppman]: manual pages for Linux/MacOS, with syntax highlighting of example code and hyperlinks between manpages. [https://github.com/aitjcize/cppman#Installation Installation] is available via {{tt|pip/AUR/apt/brew/port}}. The manpages can be generated/cached on-the-fly (online), one page per request, or all available pages can be fetched, for further "offline" browsing. | |
===Bugs=== | ===Bugs=== | ||
| − | + | All bugs in the offline archives should be reported either to the [https://en.cppreference.com/w/Cppreference_talk:Archives talk page] or to the [https://github.com/p12tic/cppreference-doc/issues issues page] of the cppreference-doc github project. | |
| − | All bugs in the offline archives should be reported either to the [ | + | |
===See also=== | ===See also=== | ||
| − | + | * The utility scripts are maintained in [https://github.com/p12tic/cppreference-doc this] git repository. | |
| − | The utility scripts are maintained in [ | + | * The Debian packaging information is maintained in [https://github.com/p12tic/cppreference-doc-debian this] git repository. |
| − | + | * An independently-maintained CHM (Windows help) archive can be found in [https://github.com/crea7or/cppreference2mshelp this] git repository. | |
| − | The | + | |
| − | + | ||
| − | An independently-maintained CHM (Windows help) archive can be found in [https://github.com/crea7or/cppreference2mshelp this] git repository. | + | |
| − | + | ||
{{langlinks|ja|zh}} | {{langlinks|ja|zh}} | ||
Latest revision as of 10:42, 10 November 2024
For convenience, several versions of the wiki suitable for offline viewing are available.
Contents |
[edit] Html book
This html book is an offline copy of the website with unnecessary UI elements stripped out. Choose this if you just want to access cppreference.com via a browser while without internet connection.
| 7 June 2019 Old versions |
File:html book 20190607.zip |
| File:html book 20190607.tar.xz |
[edit] Raw archive
This archive is a raw copy created using wget (GNU Wget). Note that this archive is not useful for viewing as-is, please use the HTML book instead. Note: the utility scripts and a makefile are contained in this package, so it can be used as full upstream source.
| 7 June 2019 Old versions |
File:cppreference-doc-20190607.zip |
| File:cppreference-doc-20190607.tar.xz |
[edit] Unofficial Release
An unofficial fork that is updated more frequently can be found in this git repository.
| 10 November 2024 Old versions |
html-book-20241110.zip (52MB) |
| html-book-20241110.tar.xz (6MB) | |
| Other files (qch and raw archive) |
[edit] Devhelp book
Devhelp is a documentation browser for GTK/Gnome.
The book is available as cppreference-doc-en-html deb package in the official Debian and Ubuntu repositories.
For arch users, the package cppreference-devhelp could be found here, which can be installed from AUR by tools like yaourt.
[edit] Qt help book
qch is a documentation format for use in the Qt tools such as QtCreator or Qt Assistant v5 / v6.
The qch book below contains a version of the html book, adapted for use with the Qt tools. Search also works.
- Note: Old versions of QtCreator or QtAssistant display the documentation improperly. If you see bad formatting, please update these programs. The oldest versions that display the contents correctly are QtCreator v3.0 and QtAssistant v4.8.6.
| 7 June 2019 Old versions |
File:qch book 20190607.zip |
| File:qch book 20190607.tar.xz |
The book is available as cppreference-doc-en-qch deb package in the official Debian and Ubuntu repositories.
The book is also provided by AUR package cppreference-qt for Arch Linux users.
[edit] Doxygen tag file
Doxygen is a tool to automatically generate documentation from source code comments. It supports automatic linking of C++ names to external documentation via tag file functionality. Two tag files are provided in the "html book" archive mentioned above:
- local: use the
cppreference-doxygen-local.tag.xmlfile to link to the local "html book" archive at the default install location. - web:
cppreference-doxygen-web.tag.xmlto link directly to the cppreference.com website.
In order to support external cppreference documentation, Doxyfile needs to be modified as follows:
- If the link target is local archive, add the following line:
- TAGFILES += "location/of/cppreference-doxygen-local.tag.xml=/location/of/html/book/root/".
- If the link target is cppreference.com, add the following line:
- TAGFILES += "location/of/cppreference-doxygen-web.tag.xml=https://en.cppreference.com/w/".
[edit] Manpages
- stdman: automatically generated man pages. Installation notes are included in the README and updates follow the offline archive releases. Last update: 1 February 2022 (~ 4.7 MB).
- cppman: manual pages for Linux/MacOS, with syntax highlighting of example code and hyperlinks between manpages. Installation is available via
pip/AUR/apt/brew/port. The manpages can be generated/cached on-the-fly (online), one page per request, or all available pages can be fetched, for further "offline" browsing.
[edit] Bugs
All bugs in the offline archives should be reported either to the talk page or to the issues page of the cppreference-doc github project.
