x64dbg/docs
Duncan Ogilvie 98adbacac9 Fix command argument escaping
Handle backslash runs before quotes using Windows-style parity rules while preserving legacy path and separator behavior. Add canonical command escaping for GUI-generated commands, regression and differential compatibility tests, and command syntax documentation.
2026-08-01 23:13:26 +02:00
..
_static Move https://github.com/x64dbg/docs into this repo 2025-07-04 01:32:42 +02:00
_templates Move https://github.com/x64dbg/docs into this repo 2025-07-04 01:32:42 +02:00
commands Fix command argument escaping 2026-08-01 23:13:26 +02:00
developers Update x64dbg trace file format documentation 2026-05-30 10:30:15 +00:00
gui Move https://github.com/x64dbg/docs into this repo 2025-07-04 01:32:42 +02:00
introduction str.streq - that doesn't exist, there is streq 2026-07-10 20:41:25 +05:00
.editorconfig Move https://github.com/x64dbg/docs into this repo 2025-07-04 01:32:42 +02:00
.gitignore Build x64dbg.chm in CI 2025-08-19 20:18:51 +02:00
.readthedocs.yaml Move https://github.com/x64dbg/docs into this repo 2025-07-04 01:32:42 +02:00
COMPILE-linux.md Msvc wine build x64 architecture (#3669) 2025-08-03 15:08:25 +02:00
conf.py Build x64dbg.chm in CI 2025-08-19 20:18:51 +02:00
genhhk.py Generate CHM index 2026-07-26 22:44:30 +02:00
hacks.css Move https://github.com/x64dbg/docs into this repo 2025-07-04 01:32:42 +02:00
index.rst Simplify licenses sections of the docs to use links instead 2025-08-18 01:45:17 +02:00
licenses.md Update API and Qt licence documentation 2025-08-26 17:52:06 +08:00
make.bat Build x64dbg.chm in CI 2025-08-19 20:18:51 +02:00
makechm.bat Generate CHM index 2026-07-26 22:44:30 +02:00
README.md Update documentation building instructions 2025-08-26 10:22:43 +00:00
requirements.txt Move https://github.com/x64dbg/docs into this repo 2025-07-04 01:32:42 +02:00
theme.js Move https://github.com/x64dbg/docs into this repo 2025-07-04 01:32:42 +02:00

docs

Documentation repository for x64dbg at Read the Docs.

Building

Run makechm.bat. It will build the .CHM help file.

When first building the .CHM help file, it automatically downloads python 2.7.18 portable and Microsoft HTML Help Compiler 4.74.8702 from GitHub. Then, 7z is used to extract the downloaded archive, so make sure 7-zip is installed, and 7z command can be accessed from the current directory.

Note: The following patch was applied:

Add relpath = relpath.replace(os.path.sep, '/') after C:\Python27\Lib\site-packages\recommonmark\transform.py line 63