hashcat/BUILD.md

hashcat build documentation
=

### Revision ###

* 1.6

### Author ###

See docs/credits.txt

### Building hashcat for Linux and macOS ###

Get a copy of the **hashcat** repository

```
$ git clone https://github.com/hashcat/hashcat.git
```

Run "make"

```
$ make
```

### Install hashcat for Linux ###

The install target is linux FHS compatible and can be used like this:

```
$ make install
```

If the $HOME/.hashcat folder exists, then:

- Session related files go to: $HOME/.hashcat/sessions/
- Cached kernels go to: $HOME/.hashcat/kernels/
- Potfiles go to: $HOME/.hashcat/

Otherwise, if environment variable XDG_DATA_HOME and XDG_CACHE_HOME exists, then:

- Session related files go to: $XDG_DATA_HOME/hashcat/sessions/
- Cached kernels go to: $XDG_CACHE_HOME/hashcat/kernels/
- Potfiles go to: $XDG_DATA_HOME/hashcat/

Otherwise, if environment variable XDG_DATA_HOME exists, then:

- Session related files go to: $XDG_DATA_HOME/hashcat/sessions/
- Cached kernels go to: $HOME/.cache/hashcat
- Potfiles go to: $XDG_DATA_HOME/hashcat/

Otherwise, if environment variable XDG_CACHE_HOME exists, then:

- Session related files go to: $HOME/.local/share/hashcat/sessions/
- Cached kernels go to: $XDG_CACHE_HOME/hashcat/kernels/
- Potfiles go to: $HOME/.local/share/hashcat/

Otherwise:

- Session related files go to: $HOME/.local/share/hashcat/sessions/
- Cached kernels go to: $HOME/.cache/hashcat
- Potfiles go to: $HOME/.local/share/hashcat/

### Building hashcat for Windows (using macOS) ###

Refer to [BUILD_macOS.md](BUILD_macOS.md)

### Building hashcat for Windows (using Windows Subsystem for Linux) ###

Refer to [BUILD_WSL.md](BUILD_WSL.md)

### Building hashcat for Windows (using Cygwin) ###

Refer to [BUILD_CYGWIN.md](BUILD_CYGWIN.md)

### Building hashcat for Windows (using MSYS2) ###

Refer to [BUILD_MSYS2.md](BUILD_MSYS2.md)

### Building hashcat for Windows from Linux ###

```
$ make win
```

=
Enjoy your fresh **hashcat** binaries ;)
Prepare to rename project into hashcat This release markes the fusion of "hashcat" and "oclHashcat" into "hashcat". It combines all features of all hashcat projects in one project. 2016-05-10 19:07:07 +02:00			`hashcat build documentation`
Initial commit 2015-12-04 15:47:52 +01:00			`=`
Update build.md 2019-03-29 13:01:17 +01:00
			`### Revision ###`

Support building windows binaries on macOS using MinGW, updated documentation 2023-05-28 21:21:20 +02:00			`* 1.6`
Initial commit 2015-12-04 15:47:52 +01:00
Update build.md 2019-03-29 13:01:17 +01:00			`### Author ###`

			`See docs/credits.txt`
Initial commit 2015-12-04 15:47:52 +01:00
Link BUILD_CYGWIN.md in BUILD.md 2019-03-29 19:23:41 +01:00			`### Building hashcat for Linux and macOS ###`
Initial commit 2015-12-04 15:47:52 +01:00
Prepare to rename project into hashcat This release markes the fusion of "hashcat" and "oclHashcat" into "hashcat". It combines all features of all hashcat projects in one project. 2016-05-10 19:07:07 +02:00			`Get a copy of the hashcat repository`
Initial commit 2015-12-04 15:47:52 +01:00
Update build.md 2019-03-29 13:01:17 +01:00			```
Prepare to rename project into hashcat This release markes the fusion of "hashcat" and "oclHashcat" into "hashcat". It combines all features of all hashcat projects in one project. 2016-05-10 19:07:07 +02:00			`$ git clone https://github.com/hashcat/hashcat.git`
Initial commit 2015-12-04 15:47:52 +01:00			```
Update for BUILD.md Make the build documentation like hashcat 2015-12-16 13:47:46 +01:00
updated BUILD.md with the notes about OpenCL-Headers + removed some target that do not exist anymore 2016-01-03 19:25:37 +01:00			`Run "make"`
Update for BUILD.md Make the build documentation like hashcat 2015-12-16 13:47:46 +01:00
Update build.md 2019-03-29 13:01:17 +01:00			```
updated BUILD.md with the notes about OpenCL-Headers + removed some target that do not exist anymore 2016-01-03 19:25:37 +01:00			`$ make`
			```

Update build.md 2019-03-29 13:01:17 +01:00			`### Install hashcat for Linux ###`
Update BUILD.md with more detailed instruction for make install 2016-01-27 19:38:25 +01:00
Update Makefile and BUILD.md 2016-02-04 09:44:52 +01:00			`The install target is linux FHS compatible and can be used like this:`
updated BUILD.md with the notes about OpenCL-Headers + removed some target that do not exist anymore 2016-01-03 19:25:37 +01:00
Update build.md 2019-03-29 13:01:17 +01:00			```
updated BUILD.md with the notes about OpenCL-Headers + removed some target that do not exist anymore 2016-01-03 19:25:37 +01:00			`$ make install`
Initial commit 2015-12-04 15:47:52 +01:00			```

apply suggested changes 2021-06-05 20:41:24 +02:00			`If the $HOME/.hashcat folder exists, then:`

			`- Session related files go to: $HOME/.hashcat/sessions/`
			`- Cached kernels go to: $HOME/.hashcat/kernels/`
			`- Potfiles go to: $HOME/.hashcat/`

			`Otherwise, if environment variable XDG_DATA_HOME and XDG_CACHE_HOME exists, then:`

			`- Session related files go to: $XDG_DATA_HOME/hashcat/sessions/`
			`- Cached kernels go to: $XDG_CACHE_HOME/hashcat/kernels/`
			`- Potfiles go to: $XDG_DATA_HOME/hashcat/`

			`Otherwise, if environment variable XDG_DATA_HOME exists, then:`

			`- Session related files go to: $XDG_DATA_HOME/hashcat/sessions/`
			`- Cached kernels go to: $HOME/.cache/hashcat`
			`- Potfiles go to: $XDG_DATA_HOME/hashcat/`

			`Otherwise, if environment variable XDG_CACHE_HOME exists, then:`

			`- Session related files go to: $HOME/.local/share/hashcat/sessions/`
			`- Cached kernels go to: $XDG_CACHE_HOME/hashcat/kernels/`
			`- Potfiles go to: $HOME/.local/share/hashcat/`

			`Otherwise:`

			`- Session related files go to: $HOME/.local/share/hashcat/sessions/`
			`- Cached kernels go to: $HOME/.cache/hashcat`
			`- Potfiles go to: $HOME/.local/share/hashcat/`
added WSL build documentation 2020-05-27 21:15:36 +02:00
Support building windows binaries on macOS using MinGW, updated documentation 2023-05-28 21:21:20 +02:00			`### Building hashcat for Windows (using macOS) ###`

			`Refer to [BUILD_macOS.md](BUILD_macOS.md)`

added WSL build documentation 2020-05-27 21:15:36 +02:00			`### Building hashcat for Windows (using Windows Subsystem for Linux) ###`

			`Refer to [BUILD_WSL.md](BUILD_WSL.md)`

Link BUILD_CYGWIN.md in BUILD.md 2019-03-29 19:23:41 +01:00			`### Building hashcat for Windows (using Cygwin) ###`

			`Refer to [BUILD_CYGWIN.md](BUILD_CYGWIN.md)`

			`### Building hashcat for Windows (using MSYS2) ###`

			`Refer to [BUILD_MSYS2.md](BUILD_MSYS2.md)`

Update build.md 2019-03-29 13:01:17 +01:00			`### Building hashcat for Windows from Linux ###`
Upgrade AMD Display Library SDK from 8.0 to 9.0 2016-01-24 16:39:51 +01:00
Update build.md 2019-03-29 13:01:17 +01:00			```
Building: Updated BUILD.md 2019-03-03 10:31:24 +01:00			`$ make win`
added note about how to fix the 'cannot find -lOpenCL' error to BUILD.md 2016-01-03 19:47:55 +01:00			```
Moved BUILD.md to root folder 2016-05-10 19:16:57 +02:00
Initial commit 2015-12-04 15:47:52 +01:00			`=`
Prepare to rename project into hashcat This release markes the fusion of "hashcat" and "oclHashcat" into "hashcat". It combines all features of all hashcat projects in one project. 2016-05-10 19:07:07 +02:00			`Enjoy your fresh hashcat binaries ;)`