Annotation of truecrypt/readme.txt, revision 1.1.1.25

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