nihilist/VeraCrypt
1
0
Fork 0
mirror of https://github.com/veracrypt/VeraCrypt synced 2024-11-10 05:03:33 +01:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: remove usage of CSS collapsible to avoid breaking CHM generation. Add new entries to CHM. Remove example script file since its content is described inline in the documentation

Browse Source 
We need to generate CHM from the same HTML files as the documentation and so we are limited by CHM compatibility
This commit is contained in:
Mounir IDRASSI 2022-12-11 18:40:33 +01:00
parent e04bf339f7
commit 4056f58add
No known key found for this signature in database
GPG Key ID: 02C30AE90FAE4A6F
11 changed files with 288 additions and 520 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -38,7 +38,12 @@ VI. Further Information
I. Windows
==========
A detailed guide on how to compile VeraCrypt on Windows can be found at: https://www.veracrypt.fr/en/CompilingGuidelineWin.html
Requirements for Building VeraCrypt for Windows:
------------------------------------------------
A detailed guide on how to build VeraCrypt on Windows can be found in
the file doc/html/CompilingGuidelineWin.html. it is also available online
at https://www.veracrypt.fr/en/CompilingGuidelineWin.html
IMPORTANT:
@ -87,7 +92,9 @@ For build instructions, please refer to the file src\Boot\EFI\Readme.txt.
II. Linux and Mac OS X
======================
A detailed guide on how to build a dev environment and on how to compile VeraCrypt on Linux can be found at: https://www.veracrypt.fr/en/CompilingGuidelineLinux.html
A detailed guide on how to build VeraCrypt on Linux can be found in
the file doc/html/CompilingGuidelineLinux.html. it is also available online
at https://www.veracrypt.fr/en/CompilingGuidelineLinux.html
Requirements for Building VeraCrypt for Linux and Mac OS X:
-----------------------------------------------------------

14
doc/chm/VeraCrypt.hhc
View File

@ -390,6 +390,20 @@
<param name="Name" value="Source Code">
<param name="Local" value="Source Code.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Building VeraCrypt From Source">
<param name="Local" value="CompilingGuidelines.html">
</OBJECT>
<UL>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Windows Build Guide">
<param name="Local" value="CompilingGuidelineWin.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Linux Build Guide">
<param name="Local" value="CompilingGuidelineLinux.html">
</OBJECT>
</UL>
</UL>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Contact">

3
doc/chm/VeraCrypt.hhp
View File

@ -50,6 +50,9 @@ Cascades.html
Changing Passwords and Keyfiles.html
Choosing Passwords and Keyfiles.html
Command Line Usage.html
CompilingGuidelineLinux.html
CompilingGuidelines.html
CompilingGuidelineWin.html
Contact.html
Contributed Resources.html
Converting TrueCrypt volumes and partitions.html

3
doc/chm/create_chm.bat
View File

@ -3,8 +3,9 @@ PATH=%PATH%;C:\Program Files (x86)\HTML Help Workshop
set CHMBUILDPATH=%~dp0
cd %CHMBUILDPATH%
copy ..\html\* .
xcopy /E ..\html\* .
hhc VeraCrypt.hhp
del /F /Q *.html *.css *.jpg *.gif *.png *.svg
rmdir /s /Q CompilingGuidelineWin ru

78
doc/html/CompilingGuidelineLinux.html
View File

@ -16,38 +16,11 @@
}
.texttohide {
display:none;
font-family: Helvetica,sans-serif;
font-size: 14px;
font-weight: normal;
}
.show {
display: none;
text-decoration: none;
}
.hide:target + .show {
display: inline;
text-decoration: none;
}
.hide:target {
display: none;
text-decoration: none;
}
.hide:target ~ .texttohide {
display:inline;
text-decoration: none;
}
@media print {
.hide, .show {
display: none;
}
}
</style>
@ -80,12 +53,16 @@
<p>
<a href="Documentation.html">Documentation</a>
<img src="arrow_right.gif" alt=">>" style="margin-top: 5px">
<a href="CompilingGuidelineLinux.html">Compiling Gudineline for Linux</a>
<a href="Technical%20Details.html">Technical Details</a>
<img src="arrow_right.gif" alt=">>" style="margin-top: 5px">
<a href="CompilingGuidelines.html">Building VeraCrypt From Source</a>
<img src="arrow_right.gif" alt=">>" style="margin-top: 5px">
<a href="CompilingGuidelineLinux.html">Linux Build Guide</a>
</p></div>
<div class="wikidoc">
This guide describes how to set up a Linux System that can compile the VeraCrypt. Further it is described how VeraCrypt is going to be compiled. <br>
The procedure for a Ubuntu 22.04 LTS system is described here as an example, but the procedure for other Linux systems is analogous.
This guide describes how to set up a Linux System to build VeraCrypt from source and how to perform compilation. <br>
The procedure for a Ubuntu 22.04 LTS system is described here as an example, the procedure for other Linux systems is analogous.
</div>
<div class="wikidoc">
@ -94,7 +71,7 @@
The following components are required for compiling VeraCrypt:
<ol>
<li>GNU Make</li>
<li>GNU C++ Compiler 4.0</li>
<li>GNU C/C++ Compiler</li>
<li>YASM 1.3.0</li>
<li>pkg-config</li>
<li>wxWidgets 3.2 shared library and header files installed or wxWidgets 3.0 library source code </li>
@ -103,8 +80,18 @@
</div>
<div class="wikidoc">
If you do not want to perform the single steps below, you can run these commands to build an environment and to compile VeraCrpyt: <br>
Download as script: <a href="LinuxPrepAndBuild.sh" target="_blank">Script</a> <br>
<p>Below are the detailed procedure steps:</p>
<ul>
<li><a href="#InstallationOfGNUMake">Installation of GNU Make</a></li>
<li><a href="#InstallationOfGNUCompiler">Installation of GNU C/C++ Compiler</a></li>
<li><a href="#InstallationOfYASM">Installation of YASM</a></li>
<li><a href="#InstallationOfPKGConfig">Installation of pkg-config</a></li>
<li><a href="#InstallationOfwxWidgets">Installation of wxWidgets 3.2</a></li>
<li><a href="#InstallationOfFuse">Installation of libfuse</a></li>
<li><a href="#DownloadVeraCrypt">Download VeraCrypt</a></li>
<li><a href="#CompileVeraCrypt">Compile VeraCrypt</a></li>
</ul>
<p>They can also be performed by running the below list of commands in a terminal or by copying them to a script:</p>
<code>
sudo apt update <br>
sudo apt install -y build-essential yasm pkg-config libgtk-3-dev <br>
@ -125,12 +112,12 @@
cd ~/VeraCrypt/src <br>
make
</code>
<p>
</div>
<div class="wikidoc">
<div class="textbox" id="InstallationOfGNUMake">
<a href="#hide1" class="hide" id="hide1">Installation of GNU Make</a>
<a href="#show1" class="show" id="show1">Installation of GNU Make</a>
<a href="#InstallationOfGNUMake">Installation of GNU Make</a>
<div class="texttohide">
<p>
<ol>
@ -150,8 +137,7 @@
</div>
<div class="textbox" id="InstallationOfGNUCompiler">
<a href="#hide2" class="hide" id="hide2">Installation of GNU C++ Compiler 4.0</a>
<a href="#show2" class="show" id="show2">Installation of GNU C++ Compiler 4.0</a>
<a href="#InstallationOfGNUCompiler">Installation of GNU C/C++ Compiler</a>
<div class="texttohide">
<p> If the build-essential were already installed in the step before, this step can be skipped.
<ol>
@ -171,8 +157,7 @@
</div>
<div class="textbox" id="InstallationOfYASM">
<a href="#hide3" class="hide" id="hide3">Installation of YASM</a>
<a href="#show3" class="show" id="show3">Installation of YASM</a>
<a href="#InstallationOfYASM">Installation of YASM</a>
<div class="texttohide">
<p>
<ol>
@ -192,8 +177,7 @@
</div>
<div class="textbox" id="InstallationOfPKGConfig">
<a href="#hide4" class="hide" id="hide4">Installation of pkg-config</a>
<a href="#show4" class="show" id="show4">Installation of pkg-config</a>
<a href="#InstallationOfPKGConfig">Installation of pkg-config</a>
<div class="texttohide">
<p>
<ol>
@ -213,8 +197,7 @@
</div>
<div class="textbox" id="InstallationOfwxWidgets">
<a href="#hide5" class="hide" id="hide5">Installation of wxWidgets 3.2</a>
<a href="#show5" class="show" id="show5">Installation of wxWidgets 3.2</a>
<a href="#InstallationOfwxWidgets">Installation of wxWidgets 3.2</a>
<div class="texttohide">
<p>
<ol>
@ -244,8 +227,7 @@
</div>
<div class="textbox" id="InstallationOfFuse">
<a href="#hide6" class="hide" id="hide6">Installation of libfuse</a>
<a href="#show6" class="show" id="show6">Installation of libfuse</a>
<a href="#InstallationOfFuse">Installation of libfuse</a>
<div class="texttohide">
<p>
<ol>
@ -265,8 +247,7 @@
</div>
<div class="textbox" id="DownloadVeraCrypt">
<a href="#hide7" class="hide" id="hide7">Download VeraCrypt</a>
<a href="#show7" class="show" id="show7">Download VeraCrypt</a>
<a href="#DownloadVeraCrypt">Download VeraCrypt</a>
<div class="texttohide">
<p>
<ol>
@ -287,8 +268,7 @@
</div>
<div class="textbox" id="CompileVeraCrypt">
<a href="#hide8" class="hide" id="hide8">Compile VeraCrypt</a>
<a href="#show8" class="show" id="show8">Compile VeraCrypt</a>
<a href="#CompileVeraCrypt">Compile VeraCrypt</a>
<div class="texttohide">
<p> Remarks: <br>
<ul>

122
doc/html/CompilingGuidelineWin.html
View File

@ -16,38 +16,11 @@
}
.texttohide {
display:none;
font-family: Helvetica,sans-serif;
font-size: 14px;
font-weight: normal;
}
.show {
display: none;
text-decoration: none;
}
.hide:target + .show {
display: inline;
text-decoration: none;
}
.hide:target {
display: none;
text-decoration: none;
}
.hide:target ~ .texttohide {
display:inline;
text-decoration: none;
}
@media print {
.hide, .show {
display: none;
}
}
</style>
@ -80,7 +53,11 @@
<p>
<a href="Documentation.html">Documentation</a>
<img src="arrow_right.gif" alt=">>" style="margin-top: 5px">
<a href="CompilingGuidelineWin.html">Compiling Gudineline for Windows</a>
<a href="Technical%20Details.html">Technical Details</a>
<img src="arrow_right.gif" alt=">>" style="margin-top: 5px">
<a href="CompilingGuidelines.html">Building VeraCrypt From Source</a>
<img src="arrow_right.gif" alt=">>" style="margin-top: 5px">
<a href="CompilingGuidelineWin.html">Windows Build Guide</a>
</p></div>
<div class="wikidoc">
@ -113,11 +90,36 @@
</div>
<div class="wikidoc">
<p>Below are the procedure steps:</p>
<ul>
<li><a href="#InstallationOfMicrosoftVisualStudio2010">Installation of Microsoft Visual Studio 2010</a></li>
<li><a href="#InstallationOfMicrosoftVisualStudio2010ServicePack1">Installation of Microsoft Visual Studio 2010 Service Pack 1</a></li>
<li><a href="#InstallationOfNASM">Installation of NASM</a></li>
<li><a href="#InstallationOfYASM">Installation of YASM</a></li>
<li><a href="#InstallationOfVisualC++">Installation of Microsoft Visual C++ 1.52</a></li>
<li><a href="#InstallationOfWindowsSDK71++">Installation of the Windows SDK 7.1</a></li>
<li><a href="#InstallationOfWDK71++">Installation of the Windows Driver Kit 7.1</a></li>
<li><a href="#InstallationOfSDK81++">Installation of the Windows 8.1 SDK</a></li>
<li><a href="#InstallationOfGzip">Installation of gzip</a></li>
<li><a href="#InstallationOfUpx">Installation of upx</a></li>
<li><a href="#InstallationOf7zip">Installation of 7zip</a></li>
<li><a href="#InstallationOfWix3">Installation of Wix3</a></li>
<li><a href="#InstallationOfVS2019">Installation of Microsoft Visual Studio 2019</a></li>
<li><a href="#InstallationOfWDK10">Installation of the Windows Driver Kit 2004</a></li>
<li><a href="#InstallationOfVisualBuildTools">Installation of the Visual Studio build tools</a></li>
<li><a href="#DownloadVeraCrypt">Download VeraCrypt Source Files</a></li>
<li><a href="#CompileWin32X64">Compile the Win32/x64 Versions of VeraCrypt</a></li>
<li><a href="#CompileARM64">Compile the ARM64 Version of VeraCrypt</a></li>
<li><a href="#BuildVeraCryptExecutables">Build the VeraCrypt Executables</a></li>
<li><a href="#ImportCertificates">Import the Certificates</a></li>
<li><a href="#KnownIssues">Known Issues</a></li>
</ul>
</div>
<div class="wikidoc">
<div class="textbox" id="InstallationOfMicrosoftVisualStudio2010">
<a href="#hide1" class="hide" id="hide1">Installation of Microsoft Visual Studio 2010</a>
<a href="#show1" class="show" id="show1">Installation of Microsoft Visual Studio 2010</a>
<a href="#InstallationOfMicrosoftVisualStudio2010">Installation of Microsoft Visual Studio 2010</a>
<div class="texttohide">
<p>
<ol>
@ -145,8 +147,7 @@
</div>
<div class="textbox" id="InstallationOfMicrosoftVisualStudio2010ServicePack1">
<a href="#hide2" class="hide" id="hide2">Installation of Microsoft Visual Studio 2010 Service Pack 1</a>
<a href="#show2" class="show" id="show2">Installation of Microsoft Visual Studio 2010 Service Pack 1</a>
<a href="#InstallationOfMicrosoftVisualStudio2010ServicePack1">Installation of Microsoft Visual Studio 2010 Service Pack 1</a>
<div class="texttohide">
<p>
Note: The content the official installer from Microsoft tries to download is no longer available. Therefore, it is necessary to use an offline installer.
@ -170,8 +171,7 @@
</div>
<div class="textbox" id="InstallationOfNASM">
<a href="#hide3" class="hide" id="hide3">Installation of NASM</a>
<a href="#show3" class="show" id="show3">Installation of NASM</a>
<a href="#InstallationOfNASM">Installation of NASM</a>
<div class="texttohide">
<p>
<ol>
@ -227,8 +227,7 @@
</div>
<div class="textbox" id="InstallationOfYASM">
<a href="#hide4" class="hide" id="hide4">Installation of YASM</a>
<a href="#show4" class="show" id="show4">Installation of YASM</a>
<a href="#InstallationOfYASM">Installation of YASM</a>
<div class="texttohide">
<p>
<ol>
@ -311,8 +310,7 @@
</div>
<div class="textbox" id="InstallationOfVisualC++">
<a href="#hide5" class="hide" id="hide5">Installation of Microsoft Visual C++ 1.52</a>
<a href="#show5" class="show" id="show5">Installation of Microsoft Visual C++ 1.52</a>
<a href="#InstallationOfVisualC++">Installation of Microsoft Visual C++ 1.52</a>
<div class="texttohide">
<p>
<ol>
@ -363,8 +361,7 @@
</div>
<div class="textbox" id="InstallationOfWindowsSDK71++">
<a href="#hide6" class="hide" id="hide6">Installation of the Windows SDK 7.1</a>
<a href="#show6" class="show" id="show6">Installation of the Windows SDK 7.1</a>
<a href="#InstallationOfWindowsSDK71++">Installation of the Windows SDK 7.1</a>
<div class="texttohide">
<p>
The installer requires .Net Framework 4 (Not a newer one like .Net Framework 4.8!). Since a newer version is already preinstalled with Windows 10, the installer has to be tricked:
@ -446,8 +443,7 @@
</div>
<div class="textbox" id="InstallationOfWDK71++">
<a href="#hide7" class="hide" id="hide7">Installation of the Windows Driver Kit 7.1</a>
<a href="#show7" class="show" id="show7">Installation of the Windows Driver Kit 7.1</a>
<a href="#InstallationOfWDK71++">Installation of the Windows Driver Kit 7.1</a>
<div class="texttohide">
<p>
<ol>
@ -471,8 +467,7 @@
</div>
<div class="textbox" id="InstallationOfSDK81++">
<a href="#hide8" class="hide" id="hide8">Installation of the Windows 8.1 SDK</a>
<a href="#show8" class="show" id="show8">Installation of the Windows 8.1 SDK</a>
<a href="#InstallationOfSDK81++">Installation of the Windows 8.1 SDK</a>
<div class="texttohide">
<p>
<ol>
@ -520,8 +515,7 @@
</div>
<div class="textbox" id="InstallationOfGzip">
<a href="#hide9" class="hide" id="hide9">Installation of gzip</a>
<a href="#show9" class="show" id="show9">Installation of gzip</a>
<a href="#InstallationOfGzip">Installation of gzip</a>
<div class="texttohide">
<p>
<ol>
@ -578,8 +572,7 @@
</div>
<div class="textbox" id="InstallationOfUpx">
<a href="#hide10" class="hide" id="hide10">Installation of upx</a>
<a href="#show10" class="show" id="show10">Installation of upx</a>
<a href="#InstallationOfUpx">Installation of upx</a>
<div class="texttohide">
<p>
<ol>
@ -636,8 +629,7 @@
</div>
<div class="textbox" id="InstallationOf7zip">
<a href="#hide11" class="hide" id="hide11">Installation of 7zip</a>
<a href="#show11" class="show" id="show11">Installation of 7zip</a>
<a href="#InstallationOf7zip">Installation of 7zip</a>
<div class="texttohide">
<p>
<ol>
@ -654,8 +646,7 @@
</div>
<div class="textbox" id="InstallationOfWix3">
<a href="#hide12" class="hide" id="hide12">Installation of Wix3</a>
<a href="#show12" class="show" id="show12">Installation of Wix3</a>
<a href="#InstallationOfWix3">Installation of Wix3</a>
<div class="texttohide">
<p>
<ol>
@ -672,8 +663,7 @@
</div>
<div class="textbox" id="InstallationOfVS2019">
<a href="#hide13" class="hide" id="hide13">Installation of Microsoft Visual Studio 2019</a>
<a href="#show13" class="show" id="show13">Installation of Microsoft Visual Studio 2019</a>
<a href="#InstallationOfVS2019">Installation of Microsoft Visual Studio 2019</a>
<div class="texttohide">
<p>
<ol>
@ -908,8 +898,7 @@
</div>
<div class="textbox" id="InstallationOfWDK10">
<a href="#hide14" class="hide" id="hide14">Installation of the Windows Driver Kit 2004</a>
<a href="#show14" class="show" id="show14">Installation of the Windows Driver Kit 2004</a>
<a href="#InstallationOfWDK10">Installation of the Windows Driver Kit 2004</a>
<div class="texttohide">
<p>
<ol>
@ -934,8 +923,7 @@
</div>
<div class="textbox" id="InstallationOfVisualBuildTools">
<a href="#hide15" class="hide" id="hide15">Installation of the Visual Studio build tools</a>
<a href="#show15" class="show" id="show15">Installation of the Visual Studio build tools</a>
<a href="#InstallationOfVisualBuildTools">Installation of the Visual Studio build tools</a>
<div class="texttohide">
<p>
<ol>
@ -1025,8 +1013,7 @@
</div>
<div class="textbox" id="DownloadVeraCrypt">
<a href="#hide16" class="hide" id="hide16">Download VeraCrypt Source Files</a>
<a href="#show16" class="show" id="show16">Download VeraCrypt Source Files</a>
<a href="#DownloadVeraCrypt">Download VeraCrypt Source Files</a>
<div class="texttohide">
<p>
<ol>
@ -1044,8 +1031,7 @@
</div>
<div class="textbox" id="CompileWin32X64">
<a href="#hide17" class="hide" id="hide17">Compile the Win32/x64 Versions of VeraCrypt</a>
<a href="#show17" class="show" id="show17">Compile the Win32/x64 Versions of VeraCrypt</a>
<a href="#CompileWin32X64">Compile the Win32/x64 Versions of VeraCrypt</a>
<div class="texttohide">
<p>
<ol>
@ -1081,8 +1067,7 @@
</div>
<div class="textbox" id="CompileARM64">
<a href="#hide18" class="hide" id="hide18">Compile the ARM64 Version of VeraCrypt</a>
<a href="#show18" class="show" id="show18">Compile the ARM64 Version of VeraCrypt</a>
<a href="#CompileARM64">Compile the ARM64 Version of VeraCrypt</a>
<div class="texttohide">
<p>
<ol>
@ -1107,8 +1092,7 @@
</div>
<div class="textbox" id="BuildVeraCryptExecutables">
<a href="#hide19" class="hide" id="hide19">Build the VeraCrypt Executables</a>
<a href="#show19" class="show" id="show19">Build the VeraCrypt Executables</a>
<a href="#BuildVeraCryptExecutables">Build the VeraCrypt Executables</a>
<div class="texttohide">
<p>
<ol>
@ -1130,8 +1114,7 @@
</div>
<div class="textbox" id="ImportCertificates">
<a href="#hide20" class="hide" id="hide20">Import the Certificates</a>
<a href="#show20" class="show" id="show20">Import the Certificates</a>
<a href="#ImportCertificates">Import the Certificates</a>
<div class="texttohide">
<p> With the sign_test.bat script you just signed the VeraCrypt executables. This is necessary, since Windows only accepts drivers, which are trusted by a signed Certificate Authority. <br>
Since you did not use the official VeraCrypt signing certificate to sign your code, but a public development version, you have to import and therefore trust the certifcates used.
@ -1156,8 +1139,7 @@
</div>
<div class="textbox" id="KnownIssues">
<a href="#hide21" class="hide" id="hide21">Known Issues</a>
<a href="#show21" class="show" id="show21">Known Issues</a>
<a href="#KnownIssues">Known Issues</a>
<div class="texttohide">
<p>
<ul>

46
doc/html/CompilingGuidelines.html Normal file
View File

@ -0,0 +1,46 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>VeraCrypt - Free Open source disk encryption with strong security for the Paranoid</title>
<meta name="description" content="VeraCrypt is free open-source disk encryption software for Windows, Mac OS X and Linux. In case an attacker forces you to reveal the password, VeraCrypt provides plausible deniability. In contrast to file encryption, data encryption performed by VeraCrypt is real-time (on-the-fly), automatic, transparent, needs very little memory, and does not involve temporary unencrypted files."/>
<meta name="keywords" content="encryption, security"/>
<link href="styles.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div>
<a href="Documentation.html"><img src="VeraCrypt128x128.png" alt="VeraCrypt"/></a>
</div>
<div id="menu">
<ul>
<li><a href="Home.html">Home</a></li>
<li><a href="/code/">Source Code</a></li>
<li><a href="Downloads.html">Downloads</a></li>
<li><a class="active" href="Documentation.html">Documentation</a></li>
<li><a href="Donation.html">Donate</a></li>
<li><a href="https://sourceforge.net/p/veracrypt/discussion/" target="_blank">Forums</a></li>
</ul>
</div>
<div>
<p>
<a href="Documentation.html">Documentation</a>
<img src="arrow_right.gif" alt=">>" style="margin-top: 5px">
<a href="Technical%20Details.html">Technical Details</a>
<img src="arrow_right.gif" alt=">>" style="margin-top: 5px">
<a href="CompilingGuidelines.html">Building VeraCrypt From Source</a>
</p></div>
<div class="wikidoc">
<h1>Building VeraCrypt From Source</h1>
<ul style="text-align:left; margin-top:18px; margin-bottom:19px; padding-top:0px; padding-bottom:0px">
<li style="text-align:left; margin-top:0px; margin-bottom:0px; padding-top:0px; padding-bottom:0px">
<a href="CompilingGuidelineWin.html" style="text-align:left; color:#0080c0; text-decoration:none.html">Windows Build Guide</a>
</li><li style="text-align:left; margin-top:0px; margin-bottom:0px; padding-top:0px; padding-bottom:0px">
<a href="CompilingGuidelineLinux.html" style="text-align:left; color:#0080c0; text-decoration:none.html">Linux Build Guide</a>
</li></ul>
</div><div class="ClearBoth"></div></body></html>

494
doc/html/Documentation.html
View File

@ -1,52 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<style>
.textbox {
vertical-align: top;
height: auto !important;
font-weight: bold;
padding: 5px;
width: auto;
border-radius: 10px;
}
.texttohide {
display:none;
font-family: Helvetica,sans-serif;
font-size: 14px;
font-weight: normal;
}
.show {
display: none;
text-decoration: none;
}
.hide:target + .show {
display: inline;
text-decoration: none;
}
.hide:target {
display: none;
text-decoration: none;
}
.hide:target ~ .texttohide {
display:inline;
text-decoration: none;
}
@media print {
.hide, .show {
display: none;
}
}
</style>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
@ -76,335 +29,124 @@
<h1>Table of Contents</h1>
<p><em style="text-align:left">This documentation is not guaranteed to be error-free and is provided &quot;as is&quot; without warranty of any kind. For more information, see
<a href="Disclaimers.html">Disclaimers</a>.</em></p>
<a title="Preface" href="Preface.html"><strong>Preface</strong></a> <br>
<a href="Introduction.html"><strong>Introduction</strong></a>
<div class="wikidoc">
<div class="textbox" id="EndUserGuides">
<a href="#hide1" class="hide" id="hide1">&#9654; &nbsp; End-User Guidelines and Information</a>
<a href="#show1" class="show" id="show1">&#9660; &nbsp; End-User Guidelines and Information</a>
<div class="texttohide">
<ul>
<li>
<strong><a href="Beginner%27s%20Tutorial.html">Beginner's Tutorial</a></strong>
</li>
<li>
<strong><a href="Main%20Program%20Window.html">Main Program Window</a></strong>
<ul>
<li>
<a href="Program%20Menu.html">Program Menu</a>
</li>
<li>
<a href="Mounting%20VeraCrypt%20Volumes.html">Mounting Volumes</a>
</li>
</ul>
</li>
<li>
<strong><a href="Portable%20Mode.html">Portable Mode</a></strong>
</li>
<li>
<strong><a href="Language%20Packs.html">Language Packs</a></strong>
</li>
<li>
<strong><a href="Supported%20Operating%20Systems.html">Supported Operating Systems</a></strong>
</li>
<li>
<strong><a href="How%20to%20Back%20Up%20Securely.html">How To Back Up Securely</a></strong>
</li>
<li>
<strong><a href="Using%20VeraCrypt%20Without%20Administrator%20Privileges.html">Using VeraCrypt Without Administrator Privileges</a></strong>
</li>
<li>
<strong><a href="Sharing%20over%20Network.html">Sharing Over Network</a></strong>
</li>
<li>
<strong><a href="VeraCrypt%20Background%20Task.html">VeraCrypt Background Task</a></strong>
</li>
<li>
<strong><a href="Removable%20Medium%20Volume.html">Volume Mounted as Removable Medium</a></strong>
</li>
<li>
<strong><a href="Removing%20Encryption.html">How To Remove Encryption</a></strong>
</li>
<li>
<strong><a href="Uninstalling%20VeraCrypt.html">Uninstalling VeraCrypt</a></strong>
</li>
</ul>
</div>
<ul>
<li><a title="Preface" href="Preface.html"><strong>Preface</strong></a>
</li><li><strong><a href="Introduction.html">Introduction</a></strong>
</li><li><strong><a href="Beginner%27s%20Tutorial.html">Beginner's Tutorial</a></strong>
</li><li><strong><a href="VeraCrypt%20Volume.html">VeraCrypt Volume</a></strong>
<ul>
<li><a href="Creating%20New%20Volumes.html">Creating a New VeraCrypt Volume</a>
</li><li><a href="Favorite%20Volumes.html">Favorite Volumes</a>
</li><li><a href="System%20Favorite%20Volumes.html">System Favorite Volumes</a>
</li></ul>
</li><li><strong><a href="System%20Encryption.html">System Encryption</a></strong>
<ul>
<li><a href="Hidden%20Operating%20System.html">Hidden Operating System</a>
</li><li><a href="Supported%20Systems%20for%20System%20Encryption.html">Operating Systems Supported for System Encryption</a>
</li><li><a href="VeraCrypt%20Rescue%20Disk.html">VeraCrypt Rescue Disk</a>
</li></ul>
</li><li><strong><a href="Plausible%20Deniability.html">Plausible Deniability</a></strong><br>
<ul>
<li><a href="Hidden%20Volume.html">Hidden Volume</a>
<ul>
<li><a href="Protection%20of%20Hidden%20Volumes.html">Protection of Hidden Volumes Against Damage</a>
</li><li><a href="Security%20Requirements%20for%20Hidden%20Volumes.html">Security Requirements and Precautions Pertaining to Hidden Volumes</a>
</li></ul>
</li><li><a href="VeraCrypt%20Hidden%20Operating%20System.html">Hidden Operating System</a>
</li></ul>
</li><li><strong><a href="Main%20Program%20Window.html">Main Program Window</a></strong>
<ul>
<li><a href="Program%20Menu.html">Program Menu</a>
</li><li><a href="Mounting%20VeraCrypt%20Volumes.html">Mounting Volumes</a>
</li></ul>
</li><li><strong><a href="Parallelization.html">Parallelization</a></strong>
</li><li><strong><a href="Pipelining.html">Pipelining</a></strong>
</li><li><strong><a href="Hardware%20Acceleration.html">Hardware acceleration</a></strong>
</li><li><strong><a href="Hot%20Keys.html">Hot keys</a></strong>
</li><li><strong><a href="Keyfiles%20in%20VeraCrypt.html">Keyfiles</a></strong>
</li><li><strong><a href="Security%20Tokens%20%26%20Smart%20Cards.html">Security Tokens &amp; Smart Cards</a></strong>
</li><li><strong><a href="Portable%20Mode.html">Portable Mode</a></strong>
</li><li><strong><a href="TrueCrypt%20Support.html">TrueCrypt Support</a></strong>
</li><li><strong><a href="Converting%20TrueCrypt%20volumes%20and%20partitions.html">Converting TrueCrypt Volumes &amp; Partitions</a></strong>
</li><li><strong><a href="Default%20Mount%20Parameters.html">Default Mount Parameters</a></strong>
</li><li><strong><a href="Language%20Packs.html">Language Packs</a></strong>
</li><li><strong><a href="Encryption%20Algorithms.html">Encryption Algorithms</a></strong>
<ul>
<li><a href="AES.html">AES</a> </li><li><a href="Camellia.html">Camellia</a>
</li><li><a href="Kuznyechik.html">Kuznyechik</a>
</li><li><a href="Serpent.html">Serpent</a> </li><li><a href="Twofish.html">Twofish</a> </li><li><a href="Cascades.html">Cascades of ciphers</a>
</li></ul>
</li><li><strong><a href="Hash%20Algorithms.html">Hash Algorithms</a></strong>
<ul>
<li><a href="BLAKE2s-256.html">BLAKE2s-256</a>
</li><li><a href="SHA-256.html">SHA-256</a> </li><li><a href="SHA-512.html">SHA-512</a> </li><li><a href="Whirlpool.html">Whirlpool</a>
</li><li><a href="Streebog.html">Streebog</a></li></ul>
</li><li><strong><a href="Supported%20Operating%20Systems.html">Supported Operating Systems</a></strong>
</li><li><strong><a href="Command%20Line%20Usage.html">Command Line Usage</a></strong>
</li><li><strong><a href="Security%20Model.html">Security Model</a></strong>
</li><li><strong><a href="Security%20Requirements%20and%20Precautions.html">Security Requirements And Precautions<br>
</a></strong>
<ul>
<li><a href="Data%20Leaks.html">Data Leaks</a>
<ul>
<li><a href="Paging%20File.html">Paging File</a>
</li><li><a href="Memory%20Dump%20Files.html">Memory Dump Files</a>
</li><li><a href="Hibernation%20File.html">Hibernation File</a>
</li></ul>
</li><li><a href="Unencrypted%20Data%20in%20RAM.html">Unencrypted Data in RAM</a>
</li><li><a href="Physical%20Security.html">Physical Security</a>
</li><li><a href="Malware.html">Malware</a> </li><li><a href="Multi-User%20Environment.html">Multi-User Environment</a>
</li><li><a href="Authenticity%20and%20Integrity.html">Authenticity and Integrity</a>
</li><li><a href="Choosing%20Passwords%20and%20Keyfiles.html">Choosing Passwords and Keyfiles</a>
</li><li><a href="Changing%20Passwords%20and%20Keyfiles.html">Changing Passwords and Keyfiles</a>
</li><li><a href="Trim%20Operation.html">Trim Operation</a>
</li><li><a href="Wear-Leveling.html">Wear-Leveling</a>
</li><li><a href="Reallocated%20Sectors.html">Reallocated Sectors</a>
</li><li><a href="Defragmenting.html">Defragmenting</a>
</li><li><a href="Journaling%20File%20Systems.html">Journaling File Systems</a>
</li><li><a href="Volume%20Clones.html">Volume Clones</a>
</li><li><a href="Additional%20Security%20Requirements%20and%20Precautions.html">Additional Security Requirements and Precautions</a>
</li></ul>
</li><li><strong><a href="How%20to%20Back%20Up%20Securely.html">How To Back Up Securely</a></strong>
</li><li><strong><a href="Miscellaneous.html">Miscellaneous</a></strong>
<ul>
<li><a href="Using%20VeraCrypt%20Without%20Administrator%20Privileges.html">Using VeraCrypt Without Administrator Privileges</a>
</li><li><a href="Sharing%20over%20Network.html">Sharing Over Network</a>
</li><li><a href="VeraCrypt%20Background%20Task.html">VeraCrypt Background Task</a>
</li><li><a href="Removable%20Medium%20Volume.html">Volume Mounted as Removable Medium</a>
</li><li><a href="VeraCrypt%20System%20Files.html">VeraCrypt System Files &amp; Application Data</a>
</li><li><a href="Removing%20Encryption.html">How To Remove Encryption</a>
</li><li><a href="Uninstalling%20VeraCrypt.html">Uninstalling VeraCrypt</a>
</li><li><a href="Digital%20Signatures.html">Digital Signatures</a>
</li></ul>
</li><li><strong><a href="Troubleshooting.html">Troubleshooting</a></strong>
</li><li><strong><a href="Incompatibilities.html">Incompatibilities</a></strong>
</li><li><strong><a href="Issues%20and%20Limitations.html">Known Issues and Limitations</a></strong>
</li><li><strong><a href="FAQ.html">Frequently Asked Questions</a></strong>
</li><li><strong><a href="Technical%20Details.html">Technical Details</a></strong>
<ul>
<li><a href="Notation.html">Notation</a>
</li><li><a href="Encryption%20Scheme.html">Encryption Scheme</a>
</li><li><a href="Modes%20of%20Operation.html">Modes of Operation</a>
</li><li><a href="Header%20Key%20Derivation.html">Header Key Derivation, Salt, and Iteration Count</a>
</li><li><a href="Random%20Number%20Generator.html">Random Number Generator</a>
</li><li><a href="Keyfiles.html">Keyfiles</a>
</li><li><a title="PIM" href="Personal%20Iterations%20Multiplier%20(PIM).html">PIM</a>
</li><li><a href="VeraCrypt%20Volume%20Format%20Specification.html">VeraCrypt Volume Format Specification</a>
</li><li><a href="Standard%20Compliance.html">Compliance with Standards and Specifications</a>
</li><li><a href="Source%20Code.html">Source Code</a>
</li><li><a href="CompilingGuidelines.html">Building VeraCrypt From Source</a>
<ul>
<li><a href="CompilingGuidelineWin.html">Windows Build Guide</a>
</li><li><a href="CompilingGuidelineLinux.html">Linux Build Guide</a>
</li></ul>
</li></ul>
</li><li><strong><a href="Contact.html">Contact</a></strong>
</li><li><strong><a href="Legal%20Information.html">Legal Information</a></strong>
</li><li><strong><a href="Release%20Notes.html">Version History</a></strong>
</li><li><strong><a href="Acknowledgements.html">Acknowledgements</a></strong>
</li><li><strong><a href="References.html">References</a></strong>
</li></ul>
</div>
<div class="wikidoc">
<div class="textbox" id="SoftwareDevGuidelines">
<a href="#hide2" class="hide" id="hide2">&#9654; &nbsp; Software Development Guidelines</a>
<a href="#show2" class="show" id="show2">&#9660; &nbsp; Software Development Guidelines</a>
<div class="texttohide">
<ul>
<li>
<strong><a href="CompilingGuidelineWin.html">Windows Compiling Guideline</a></strong>
</li>
<li>
<strong><a href="CompilingGuidelineLinux.html">Linux Compiling Guideline</a></strong>
</li>
</ul>
</div>
</div>
<div class="wikidoc">
<div class="textbox" id="TechnicalDetails">
<a href="#hide3" class="hide" id="hide3">&#9654; &nbsp; Technical Details</a>
<a href="#show3" class="show" id="show3">&#9660; &nbsp; Technical Details</a>
<div class="texttohide">
<ul>
<li>
<strong><a href="VeraCrypt%20Volume.html">VeraCrypt Volume</a></strong>
<ul>
<li>
<a href="Creating%20New%20Volumes.html">Creating a New VeraCrypt Volume</a>
</li>
<li>
<a href="Favorite%20Volumes.html">Favorite Volumes</a>
</li>
<li>
<a href="System%20Favorite%20Volumes.html">System Favorite Volumes</a>
</li>
</ul>
</li>
<li>
<strong><a href="System%20Encryption.html">System Encryption</a></strong>
<ul>
<li>
<a href="Hidden%20Operating%20System.html">Hidden Operating System</a>
</li>
<li>
<a href="Supported%20Systems%20for%20System%20Encryption.html">Operating Systems Supported for System Encryption</a>
</li>
<li>
<a href="VeraCrypt%20Rescue%20Disk.html">VeraCrypt Rescue Disk</a>
</li>
</ul>
</li>
<li>
<strong><a href="Plausible%20Deniability.html">Plausible Deniability</a></strong><br>
<ul>
<li>
<a href="Hidden%20Volume.html">Hidden Volume</a>
<ul>
<li>
<a href="Protection%20of%20Hidden%20Volumes.html">Protection of Hidden Volumes Against Damage</a>
</li>
<li>
<a href="Security%20Requirements%20for%20Hidden%20Volumes.html">Security Requirements and Precautions Pertaining to Hidden Volumes</a>
</li>
</ul>
</li>
<li>
<a href="VeraCrypt%20Hidden%20Operating%20System.html">Hidden Operating System</a>
</li>
</ul>
</li>
<li>
<strong><a href="Encryption%20Algorithms.html">Encryption Algorithms</a></strong>
<ul>
<li>
<a href="AES.html">AES</a> </li><li><a href="Camellia.html">Camellia</a>
</li>
<li>
<a href="Kuznyechik.html">Kuznyechik</a>
</li>
<li>
<a href="Serpent.html">Serpent</a>
</li>
<li>
<a href="Twofish.html">Twofish</a>
</li>
<li>
<a href="Cascades.html">Cascades of ciphers</a>
</li>
</ul>
</li>
<li>
<strong><a href="Hash%20Algorithms.html">Hash Algorithms</a></strong>
<ul>
<li>
<a href="BLAKE2s-256.html">BLAKE2s-256</a>
</li>
<li>
<a href="SHA-256.html">SHA-256</a>
</li>
<li>
<a href="SHA-512.html">SHA-512</a>
</li>
<li>
<a href="Whirlpool.html">Whirlpool</a>
</li>
<li>
<a href="Streebog.html">Streebog</a>
</li>
</ul>
</li>
<li>
<strong><a href="Security%20Requirements%20and%20Precautions.html">Security Requirements And Precautions<br> </a></strong>
<ul>
<li>
<a href="Data%20Leaks.html">Data Leaks</a>
<ul>
<li>
<a href="Paging%20File.html">Paging File</a>
</li>
<li>
<a href="Memory%20Dump%20Files.html">Memory Dump Files</a>
</li>
<li>
<a href="Hibernation%20File.html">Hibernation File</a>
</li>
</ul>
</li>
<li>
<a href="Unencrypted%20Data%20in%20RAM.html">Unencrypted Data in RAM</a>
</li>
<li>
<a href="Physical%20Security.html">Physical Security</a>
</li>
<li>
<a href="Malware.html">Malware</a>
</li>
<li>
<a href="Multi-User%20Environment.html">Multi-User Environment</a>
</li>
<li>
<a href="Authenticity%20and%20Integrity.html">Authenticity and Integrity</a>
</li>
<li>
<a href="Choosing%20Passwords%20and%20Keyfiles.html">Choosing Passwords and Keyfiles</a>
</li>
<li>
<a href="Changing%20Passwords%20and%20Keyfiles.html">Changing Passwords and Keyfiles</a>
</li>
<li>
<a href="Trim%20Operation.html">Trim Operation</a>
</li>
<li>
<a href="Wear-Leveling.html">Wear-Leveling</a>
</li>
<li>
<a href="Reallocated%20Sectors.html">Reallocated Sectors</a>
</li>
<li>
<a href="Defragmenting.html">Defragmenting</a>
</li>
<li>
<a href="Journaling%20File%20Systems.html">Journaling File Systems</a>
</li>
<li>
<a href="Volume%20Clones.html">Volume Clones</a>
</li>
<li>
<a href="Additional%20Security%20Requirements%20and%20Precautions.html">Additional Security Requirements and Precautions</a>
</li>
</ul>
</li>
<li>
<strong><a href="Parallelization.html">Parallelization</a></strong>
</li>
<li>
<strong><a href="Pipelining.html">Pipelining</a></strong>
</li>
<li>
<strong><a href="Hardware%20Acceleration.html">Hardware acceleration</a></strong>
</li>
<li>
<strong><a href="Hot%20Keys.html">Hot keys</a></strong>
</li>
<li>
<strong><a href="Keyfiles%20in%20VeraCrypt.html">Keyfiles</a></strong>
</li>
<li>
<strong><a href="Security%20Tokens%20%26%20Smart%20Cards.html">Security Tokens &amp; Smart Cards</a></strong>
</li>
<li>
<strong><a href="TrueCrypt%20Support.html">TrueCrypt Support</a></strong>
</li>
<li>
<strong><a href="Converting%20TrueCrypt%20volumes%20and%20partitions.html">Converting TrueCrypt Volumes &amp; Partitions</a></strong>
</li>
<li>
<strong><a href="Default%20Mount%20Parameters.html">Default Mount Parameters</a></strong>
</li>
<li>
<strong><a href="Command%20Line%20Usage.html">Command Line Usage</a></strong>
</li>
<li>
<strong><a href="Security%20Model.html">Security Model</a></strong>
</li>
<li>
<strong><a href="Technical%20Details.html">Technical Details</a></strong>
<ul>
<li>
<a href="Notation.html">Notation</a>
</li>
<li>
<a href="Encryption%20Scheme.html">Encryption Scheme</a>
</li>
<li>
<a href="Modes%20of%20Operation.html">Modes of Operation</a>
</li>
<li>
<a href="Header%20Key%20Derivation.html">Header Key Derivation, Salt, and Iteration Count</a>
</li>
<li>
<a href="Random%20Number%20Generator.html">Random Number Generator</a>
</li>
<li>
<a href="Keyfiles.html">Keyfiles</a>
</li>
<li>
<a title="PIM" href="Personal%20Iterations%20Multiplier%20(PIM).html">PIM</a>
</li>
<li>
<a href="VeraCrypt%20Volume%20Format%20Specification.html">VeraCrypt Volume Format Specification</a>
</li>
<li>
<a href="Standard%20Compliance.html">Compliance with Standards and Specifications</a>
</li>
<li>
<a href="Source%20Code.html">Source Code</a>
</li>
</ul>
</li>
<li>
<strong><a href="VeraCrypt%20System%20Files.html">VeraCrypt System Files &amp; Application Data</a></strong>
</li>
<li>
<strong><a href="Digital%20Signatures.html">Digital Signatures</a></strong>
</li>
</ul>
</div>
</div>
</div>
<strong><a href="Troubleshooting.html">Troubleshooting</a></strong> <br>
<strong><a href="Incompatibilities.html">Incompatibilities</a></strong> <br>
<strong><a href="Issues%20and%20Limitations.html">Known Issues and Limitations</a></strong> <br>
<strong><a href="FAQ.html">Frequently Asked Questions</a></strong> <br>
<strong><a href="Contact.html">Contact</a></strong> <br>
<strong><a href="Legal%20Information.html">Legal Information</a></strong> <br>
<strong><a href="Release%20Notes.html">Version History</a></strong> <br>
<strong><a href="Acknowledgements.html">Acknowledgements</a></strong> <br>
<strong><a href="References.html">References</a></strong> <br>
</body></html>

20
doc/html/LinuxPrepAndBuild.sh
View File

@ -1,20 +0,0 @@
#!/bin/bash
sudo apt update
sudo apt install -y build-essential yasm pkg-config libgtk-3-dev
wget https://github.com/wxWidgets/wxWidgets/releases/download/v3.2.0/wxWidgets-3.2.0.tar.bz2
tar -xf wxWidgets-3.2.0.tar.bz2
cd wxWidgets-3.2.0
mkdir gtk-build
cd gtk-build
../configure
make
sudo make install
sudo ldconfig
cd ../..
rm -r wxWidgets-3.2.0
rm wxWidgets-3.2.0.tar.bz2
sudo apt install -y libfuse-dev git
git clone https://github.com/veracrypt/VeraCrypt.git
cd ~/VeraCrypt/src
make

9
doc/html/Technical Details.html
View File

@ -55,5 +55,14 @@ <h1>Technical Details</h1>
<a href="Standard%20Compliance.html" style="text-align:left; color:#0080c0; text-decoration:none.html">Compliance with Standards and Specifications</a>
</li><li style="text-align:left; margin-top:0px; margin-bottom:0px; padding-top:0px; padding-bottom:0px">
<a href="Source%20Code.html" style="text-align:left; color:#0080c0; text-decoration:none.html">Source Code</a>
</li><li style="text-align:left; margin-top:0px; margin-bottom:0px; padding-top:0px; padding-bottom:0px">
<a href="CompilingGuidelines.html" style="text-align:left; color:#0080c0; text-decoration:none.html">Building VeraCrypt From Source</a>
<ul>
<li style="text-align:left; margin-top:0px; margin-bottom:0px; padding-top:0px; padding-bottom:0px">
<a href="CompilingGuidelineWin.html" style="text-align:left; color:#0080c0; text-decoration:none.html">Windows Build Guide</a>
</li><li style="text-align:left; margin-top:0px; margin-bottom:0px; padding-top:0px; padding-bottom:0px">
<a href="CompilingGuidelineLinux.html" style="text-align:left; color:#0080c0; text-decoration:none.html">Linux Build Guide</a>
</li>
</ul>
</li></ul>
</div><div class="ClearBoth"></div></body></html>

8
src/Readme.txt
View File

@ -41,7 +41,9 @@ I. Windows
Requirements for Building VeraCrypt for Windows:
------------------------------------------------
A detailed guide on how to compile VeraCrypt on Windows can be found at: https://www.veracrypt.fr/en/CompilingGuidelineWin.html
A detailed guide on how to build VeraCrypt on Windows can be found in
the file doc/html/CompilingGuidelineWin.html. it is also available online
at https://www.veracrypt.fr/en/CompilingGuidelineWin.html
IMPORTANT:
@ -90,7 +92,9 @@ For build instructions, please refer to the file src\Boot\EFI\Readme.txt.
II. Linux and Mac OS X
======================
A detailed guide on how to build a dev environment and on how to compile VeraCrypt on Linux can be found at: https://www.veracrypt.fr/en/CompilingGuidelineLinux.html
A detailed guide on how to build VeraCrypt on Linux can be found in
the file doc/html/CompilingGuidelineLinux.html. it is also available online
at https://www.veracrypt.fr/en/CompilingGuidelineLinux.html
Requirements for Building VeraCrypt for Linux and Mac OS X:
-----------------------------------------------------------