Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
hakavlad committed Mar 30, 2024
1 parent cff5915 commit 7e59a89
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,8 @@ Just start `tird`, select a menu option, and then answer the questions that `tir
$ tird
```

See below for examples of usage.

## Debug

Start `tird` with the option `--debug` or `-d` to look under the hood while the program is running:
Expand All @@ -90,6 +92,18 @@ Start `tird` with the option `--debug` or `-d` to look under the hood while the
$ tird -d
```

Enabling debug messages additionally shows:
- opening and closing file descriptors;
- real paths to opened files;
- moving file pointers using the seek() method;
- salts, passphrases, digests, keys, nonces, tags;
- some other info.

## Examples

- [Creating files with uniform random data](https://github.com/hakavlad/tird/blob/main/docs/examples/8.md) (creating keyfiles and containers)
- [Overwriting file contents with uniform random data](https://github.com/hakavlad/tird/blob/main/docs/examples/9.md) (wiping files and preparing containers)

## Requirements

- Python >= 3.6
Expand Down

0 comments on commit 7e59a89

Please sign in to comment.