Annotation of truecrypt/readme.txt, revision 1.1.1.28

1.1.1.28! root        1: This archive contains the source code of TrueCrypt 7.1.
1.1       root        2: 
                      3: 
1.1.1.8   root        4: Important
                      5: =========
1.1       root        6: 
1.1.1.16  root        7: You may use the source code contained in this archive only if you accept and
1.1.1.28! root        8: agree to the license terms contained in the file 'License.txt', which is
        !             9: included in this archive.
        !            10: 
        !            11: Note that the license specifies, for example, that a derived work must not be
        !            12: called 'TrueCrypt'.
1.1       root       13: 
                     14: 
                     15: 
1.1.1.8   root       16: Contents
                     17: ========
1.1       root       18: 
1.1.1.8   root       19: I. Windows
                     20:        Requirements for Building TrueCrypt for Windows
                     21:        Instructions for Building TrueCrypt for Windows
                     22: 
1.1.1.14  root       23: II. Linux and Mac OS X
                     24:        Requirements for Building TrueCrypt for Linux and Mac OS X
                     25:        Instructions for Building TrueCrypt for Linux and Mac OS X
1.1.1.20  root       26:        Requirements for Running TrueCrypt on Linux
                     27:        Requirements for Running TrueCrypt on Mac OS X
1.1.1.22  root       28:        
1.1.1.28! root       29: III. FreeBSD and OpenSolaris
1.1.1.8   root       30: 
1.1.1.22  root       31: IV. Third-Party Developers (Contributors)
1.1.1.8   root       32: 
1.1.1.24  root       33: V. Legal Information
                     34: 
                     35: VI. Further Information
1.1.1.8   root       36: 
                     37: 
                     38: 
                     39: I. Windows
                     40: ==========
                     41: 
                     42: Requirements for Building TrueCrypt for Windows:
                     43: ------------------------------------------------
                     44: 
1.1.1.20  root       45: - Microsoft Visual C++ 2008 SP1 (Professional Edition or compatible)
1.1.1.18  root       46: - Microsoft Visual C++ 1.52 (available from MSDN Subscriber Downloads)
1.1.1.27  root       47: - Microsoft Windows SDK for Windows 7 (configured for Visual C++)
1.1.1.26  root       48: - Microsoft Windows Driver Kit 7.1.0 (build 7600.16385.1)
1.1.1.20  root       49: - RSA Security Inc. PKCS #11 Cryptographic Token Interface (Cryptoki) 2.20
1.1.1.21  root       50:   header files (available at ftp://ftp.rsasecurity.com/pub/pkcs/pkcs-11/v2-20)
1.1.1.26  root       51: - NASM assembler 2.08 or compatible
1.1.1.16  root       52: - gzip compressor
1.1.1.13  root       53: 
                     54: IMPORTANT:
                     55: 
1.1.1.22  root       56: The 64-bit editions of Windows Vista and later versions of Windows, and in
                     57: some cases (e.g. playback of HD DVD content) also the 32-bit editions, do not
                     58: allow the TrueCrypt driver to run without an appropriate digital signature.
                     59: Therefore, all .sys files in official TrueCrypt binary packages are digitally
                     60: signed with the digital certificate of the TrueCrypt Foundation, which was
                     61: issued by a certification authority. At the end of each official .exe and
                     62: .sys file, there are embedded digital signatures and all related certificates
                     63: (i.e. all certificates in the relevant certification chain, such as the
                     64: certification authority certificates, CA-MS cross-certificate, and the
                     65: TrueCrypt Foundation certificate). Keep this in mind if you compile TrueCrypt
                     66: and compare your binaries with the official binaries. If your binaries are
1.1.1.25  root       67: unsigned, the sizes of the official binaries will usually be approximately
                     68: 10 KB greater than sizes of your binaries (there may be further differences
                     69: if you use a different version of the compiler, or if you install a different
                     70: or no service pack for Visual Studio, or different hotfixes for it, or if you
                     71: use different versions of the required SDKs).
1.1.1.12  root       72: 
1.1.1.8   root       73: 
                     74: Instructions for Building TrueCrypt for Windows:
                     75: ------------------------------------------------
                     76: 
1.1.1.28! root       77: 1) Create an environment variable 'MSVC16_ROOT' pointing to the folder 'MSVC15'
        !            78:    extracted from the Visual C++ 1.52 self-extracting package.
        !            79: 
        !            80:    Note: The 16-bit installer MSVC15\SETUP.EXE cannot be run on 64-bit Windows,
        !            81:    but it is actually not necessary to run it. You only need to extract the
        !            82:    folder 'MSVC15', which contains the 32-bit binaries required to build the
        !            83:    TrueCrypt Boot Loader.
1.1.1.8   root       84: 
1.1.1.16  root       85: 2) If you have installed the Windows Driver Development Kit in another
1.1.1.22  root       86:    directory than '%SYSTEMDRIVE%\WinDDK', create an environment variable
1.1.1.18  root       87:    'WINDDK_ROOT' pointing to the DDK installation directory.
1.1.1.8   root       88: 
1.1.1.21  root       89: 3) Copy the PKCS #11 header files to a standard include path or create an
1.1.1.22  root       90:    environment variable 'PKCS11_INC' pointing to the directory where
1.1.1.21  root       91:    the PKCS #11 header files are installed.
1.1.1.20  root       92: 
1.1.1.28! root       93: 4) Open the solution file 'TrueCrypt.sln' in Microsoft Visual Studio 2008.
1.1.1.20  root       94: 
                     95: 5) Select 'All' as the active solution configuration.
1.1.1.13  root       96: 
1.1.1.20  root       97: 6) Build the solution.
1.1.1.8   root       98: 
1.1.1.20  root       99: 7) If successful, there should be newly built TrueCrypt binaries in the
1.1.1.14  root      100:    'Release' folder.
1.1.1.8   root      101: 
                    102: 
                    103: 
1.1.1.14  root      104: II. Linux and Mac OS X
                    105: ======================
1.1.1.8   root      106: 
1.1.1.14  root      107: Requirements for Building TrueCrypt for Linux and Mac OS X:
                    108: -----------------------------------------------------------
1.1.1.8   root      109: 
1.1.1.14  root      110: - GNU Make
                    111: - GNU C++ Compiler 4.0 or compatible
1.1.1.24  root      112: - Apple Xcode (Mac OS X only)
1.1.1.26  root      113: - NASM assembler 2.08 or compatible (x86/x64 architecture only)
1.1.1.14  root      114: - pkg-config
1.1.1.20  root      115: - wxWidgets 2.8 shared library and header files installed or
                    116:   wxWidgets 2.8 library source code (available at http://www.wxwidgets.org)
                    117: - FUSE library and header files (available at http://fuse.sourceforge.net
                    118:   and http://code.google.com/p/macfuse)
                    119: - RSA Security Inc. PKCS #11 Cryptographic Token Interface (Cryptoki) 2.20
1.1.1.21  root      120:   header files (available at ftp://ftp.rsasecurity.com/pub/pkcs/pkcs-11/v2-20)
1.1.1.20  root      121:   located in a standard include path or in a directory defined by the
                    122:   environment variable 'PKCS11_INC'.
1.1.1.8   root      123: 
                    124: 
1.1.1.14  root      125: Instructions for Building TrueCrypt for Linux and Mac OS X:
                    126: -----------------------------------------------------------
1.1.1.8   root      127: 
1.1.1.14  root      128: 1) Change the current directory to the root of the TrueCrypt source code.
1.1.1.8   root      129: 
1.1.1.20  root      130: 2) If you have no wxWidgets shared library installed, run the following
                    131:    command to configure the wxWidgets static library for TrueCrypt and to
                    132:    build it: 
1.1.1.8   root      133: 
1.1.1.14  root      134:    $ make WX_ROOT=/usr/src/wxWidgets wxbuild
1.1.1.8   root      135: 
1.1.1.16  root      136:    The variable WX_ROOT must point to the location of the source code of the
                    137:    wxWidgets library. Output files will be placed in the './wxrelease/'
                    138:    directory.
                    139: 
                    140: 3) To build TrueCrypt, run the following command:
1.1.1.8   root      141: 
1.1.1.14  root      142:    $ make
1.1.1.13  root      143: 
1.1.1.20  root      144:    or if you have no wxWidgets shared library installed:
                    145:    
                    146:    $ make WXSTATIC=1
                    147: 
1.1.1.16  root      148: 4) If successful, the TrueCrypt executable should be located in the directory
                    149:    'Main'.
1.1.1.8   root      150: 
1.1.1.18  root      151: By default, a universal executable supporting both graphical and text user
                    152: interface is built. To build a console-only executable, which requires no GUI
                    153: library, use the 'NOGUI' parameter:
1.1.1.17  root      154: 
                    155:    $ make NOGUI=1 WX_ROOT=/usr/src/wxWidgets wxbuild
1.1.1.20  root      156:    $ make NOGUI=1 WXSTATIC=1
                    157: 
                    158: 
                    159: Requirements for Running TrueCrypt on Linux:
                    160: --------------------------------------------
                    161: 
1.1.1.22  root      162: - Kernel including FUSE, device mapper, and encryption modules
1.1.1.20  root      163: - FUSE library (available at http://fuse.sourceforge.net)
1.1.1.22  root      164: - device mapper tools (available at http://sources.redhat.com/dm)
1.1.1.20  root      165: 
                    166: 
                    167: Requirements for Running TrueCrypt on Mac OS X:
                    168: -----------------------------------------------
                    169: 
1.1.1.28! root      170: - Mac OS X 10.4 or compatible
        !           171: - MacFUSE 1.3 or compatible (available at http://code.google.com/p/macfuse) or
        !           172:   OSXFUSE 2.3 or compatible (available at http://osxfuse.github.com)
1.1.1.8   root      173: 
                    174: 
1.1.1.28! root      175: III. FreeBSD and OpenSolaris
1.1.1.22  root      176: ============================
                    177: 
                    178: Support status for FreeBSD: http://www.truecrypt.org/misc/freebsd
1.1.1.28! root      179: Support status for OpenSolaris: http://www.truecrypt.org/misc/opensolaris
1.1.1.22  root      180: 
                    181: 
                    182: 
                    183: IV. Third-Party Developers (Contributors)
                    184: =========================================
1.1.1.8   root      185: 
                    186: If you intend to implement a feature, please contact us first to make sure:
                    187: 
                    188: 1) That the feature has not been implemented (we may have already implemented
                    189:    it, but haven't released the code yet).
                    190: 2) That the feature is acceptable.
                    191: 3) Whether we need help of third-party developers with implementing the feature.
1.1.1.13  root      192: 
                    193: Information on how to contact us can be found at:
1.1.1.22  root      194: http://www.truecrypt.org/contact
1.1.1.8   root      195: 
                    196: 
                    197: 
1.1.1.24  root      198: V. Legal Information
                    199: ====================
                    200: 
                    201: Copyright Information
                    202: ---------------------
                    203: 
                    204: This software as a whole:
1.1.1.28! root      205: Copyright (c) 2011 TrueCrypt Developers Association. All rights reserved.
1.1.1.24  root      206: 
                    207: Portions of this software:
1.1.1.28! root      208: Copyright (c) 2003-2011 TrueCrypt Developers Association. All rights reserved.
1.1.1.24  root      209: Copyright (c) 1998-2000 Paul Le Roux. All rights reserved.
                    210: Copyright (c) 1998-2008 Brian Gladman, Worcester, UK. All rights reserved.
                    211: Copyright (c) 2002-2004 Mark Adler. All rights reserved.
                    212: For more information, please see the legal notices attached to parts of the
                    213: source code.
                    214: 
                    215: Trademark Information
                    216: ---------------------
                    217: 
1.1.1.25  root      218: TrueCrypt and the TrueCrypt logo are registered trademarks.
1.1.1.24  root      219: Note: The goal is not to monetize the name or the product, but to protect
                    220: the reputation of TrueCrypt, and to prevent support issues and other kinds
                    221: of issues that might arise from the existence of similar products with
                    222: the same or similar name. Even though TrueCrypt is a trademark, TrueCrypt
                    223: is and will remain open-source and free software.
                    224: 
                    225: Any other trademarks are the sole property of their respective owners.
                    226: 
                    227: 
                    228: 
                    229: VI. Further Information
                    230: =======================
1.1.1.8   root      231: 
1.1.1.13  root      232: http://www.truecrypt.org

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.