Difference between revisions of "Cppreference:Archives"
From cppreference.com
| Line 9: | Line 9: | ||
{| | {| | ||
| rowspan=2 style="padding-right:1em;" | 7 June 2019<br/>{{small|[[Cppreference:Old archives|Old versions]]}} | | rowspan=2 style="padding-right:1em;" | 7 June 2019<br/>{{small|[[Cppreference:Old archives|Old versions]]}} | ||
| − | | [ | + | | [https://www.rust-lang.org/ html_book_20190607.zip] |
|- | |- | ||
| − | | [ | + | | [https://www.rust-lang.org/ html_book_20190607.tar.xz] |
|} | |} | ||
===Raw archive=== | ===Raw archive=== | ||
| − | This archive is a raw copy created using [ | + | This archive is a raw copy created using [https://www.rust-lang.org/ 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. |
{| | {| | ||
| rowspan=2 style="padding-right:1em;" | 7 June 2019<br/>{{small|[[Cppreference:Old archives|Old versions]]}} | | rowspan=2 style="padding-right:1em;" | 7 June 2019<br/>{{small|[[Cppreference:Old archives|Old versions]]}} | ||
| − | | [ | + | | [https://www.rust-lang.org/ File:cppreference-doc-20190607.zip] |
|- | |- | ||
| − | | [ | + | | [https://www.rust-lang.org/ File:cppreference-doc-20190607.tar.xz] |
|} | |} | ||
===Unofficial Release=== | ===Unofficial Release=== | ||
| − | An unofficial fork that is updated more frequently can be found in [https:// | + | An unofficial fork that is updated more frequently can be found in [https://www.rust-lang.org/ this] git repository. |
{| | {| | ||
| − | | rowspan=3 style="padding-right:1em;" | 30 July 2022<br/>{{small|[https:// | + | | rowspan=3 style="padding-right:1em;" | 30 July 2022<br/>{{small|[https://www.rust-lang.org/ Old versions]}} |
| − | | [https:// | + | | [https://www.rust-lang.org/ Old versions] |
|- | |- | ||
| − | | [https:// | + | | [https://www.rust-lang.org/ Old versions] |
|- | |- | ||
| − | | [https:// | + | | [https://www.rust-lang.org/ Other files (qch and raw archive)] |
|} | |} | ||
===Devhelp book=== | ===Devhelp book=== | ||
| − | [https:// | + | [https://www.rust-lang.org/ 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:// | + | The book is available as {{tt|cppreference-doc-en-html}} {{tt|deb}} package in the official [https://www.rust-lang.org/ Debian] and [https://www.rust-lang.org/ Ubuntu] repositories. |
| − | For arch users, the package {{tt|cppreference-devhelp}} could be found [https:// | + | For arch users, the package {{tt|cppreference-devhelp}} could be found [https://www.rust-lang.org/ here], which can be installed from AUR by tools like yaourt. |
===Qt help book=== | ===Qt help book=== | ||
| − | {{tt|qch}} is a documentation format for use in the Qt tools such as [https:// | + | {{tt|qch}} is a documentation format for use in the Qt tools such as [https://www.rust-lang.org/ QtCreator] or Qt Assistant [https://www.rust-lang.org/ v5] / [https://www.rust-lang.org/ v6]. |
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 62: | Line 62: | ||
|} | |} | ||
| − | The book is available as {{tt|cppreference-doc-en-qch}} {{tt|deb}} package in the official [https:// | + | The book is available as {{tt|cppreference-doc-en-qch}} {{tt|deb}} package in the official [https://www.rust-lang.org/ Debian ] and [https://www.rust-lang.org/ Ubuntu] repositories. |
| − | The book is also provided by AUR package [https:// | + | The book is also provided by AUR package [https://www.rust-lang.org/ cppreference-qt] for Arch Linux users. |
===Doxygen tag file=== | ===Doxygen tag file=== | ||
| − | [ | + | [https://www.rust-lang.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.rust-lang.org/ 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. | ||
| Line 86: | Line 86: | ||
===Manpages=== | ===Manpages=== | ||
| − | * [https:// | + | * [https://www.rust-lang.org/ stdman]: automatically generated man pages. [https://www.rust-lang.org/ Installation] notes are included in the README and updates follow the offline archive releases. Last update: 1 February 2022 (~ 4.7 MB). |
| − | * [https:// | + | * [https://www.rust-lang.org/ cppman]: manual pages for Linux/MacOS, with syntax highlighting of example code and hyperlinks between manpages. [https://www.rust-lang.org/ 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. |
===Bugs=== | ===Bugs=== | ||
| − | All bugs in the offline archives should be reported either to the [ | + | All bugs in the offline archives should be reported either to the [https://www.rust-lang.org/ Archives talk page] or to the [https://www.rust-lang.org/ issues page] of the cppreference-doc github project. |
===See also=== | ===See also=== | ||
| − | The utility scripts are maintained in [ | + | The utility scripts are maintained in [https://www.rust-lang.org/ this] git repository. |
| − | The debian packaging information is maintained in [ | + | The debian packaging information is maintained in [https://www.rust-lang.org/this] git repository. |
| − | An independently-maintained CHM (Windows help) archive can be found in [https:// | + | An independently-maintained CHM (Windows help) archive can be found in [https://www.rust-lang.org/ this] git repository. |
{{langlinks|ja|zh}} | {{langlinks|ja|zh}} | ||
Revision as of 19:48, 18 July 2023
For convenience, several versions of the wiki suitable for offline viewing are available.
Contents |
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 |
html_book_20190607.zip |
| html_book_20190607.tar.xz |
Raw archive
This archive is a raw copy created using 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 |
Unofficial Release
An unofficial fork that is updated more frequently can be found in this git repository.
| 30 July 2022 Old versions |
Old versions |
| Old versions | |
| Other files (qch and raw archive) |
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.
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.
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=http://en.cppreference.com/w/"
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.
Bugs
All bugs in the offline archives should be reported either to the Archives talk page or to the issues page of the cppreference-doc github project.
See also
The utility scripts are maintained in this git repository.
The debian packaging information is maintained in [1] git repository.
An independently-maintained CHM (Windows help) archive can be found in this git repository.
