Skip to content

Commit

Permalink
update documentation for 0.7.3
Browse files Browse the repository at this point in the history
  • Loading branch information
Jan Starke committed Aug 23, 2023
1 parent cf87156 commit 310ac6c
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 6 deletions.
4 changes: 2 additions & 2 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "dfir-toolkit"
version = "0.7.2"
version = "0.7.3"
edition = "2021"
authors = ["Jan Starke <jan.starke@posteo.de>"]
description = "CLI tools for digital forensics and incident response"
Expand Down
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,14 @@
cargo install dfir-toolkit
```

To generate autocompletion scripts for your shell, invoke the tool with the `--autocomplete` option, e.g.

```bash
mactime2 --autocomplete bash | sudo tee /etc/bash_completion.d/mactime2
```

would install a autocompletion script in `/etc/bash_completion.d/mactime2`.

# Tools
# Command-Line Help for `cleanhive`

Expand All @@ -50,7 +58,7 @@ This document contains the help content for the `cleanhive` command-line program

merges logfiles into a hive file

**Usage:** `cleanhive [OPTIONS] --output <DST_HIVE> <HIVE_FILE>`
**Usage:** `cleanhive [OPTIONS] <HIVE_FILE>`

###### **Arguments:**

Expand All @@ -62,7 +70,8 @@ merges logfiles into a hive file
* `-v`, `--verbose` — More output per occurrence
* `-q`, `--quiet` — Less output per occurrence
* `-O`, `--output <DST_HIVE>` — name of the file to which the cleaned hive will be written
* `--markdown-help` — print help in markdown format

Default value: `-`



Expand Down Expand Up @@ -531,7 +540,6 @@ CLI tools for digital forensics and incident response
* `--strict` — strict mode: do not only warn, but abort if an error occurs
* `-v`, `--verbose` — More output per occurrence
* `-q`, `--quiet` — Less output per occurrence
* `--markdown-help` — print help in markdown format



Expand Down
8 changes: 8 additions & 0 deletions scripts/update-md.sh
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,14 @@ cat >README.md <<'EOF'
cargo install dfir-toolkit
```
To generate autocompletion scripts for your shell, invoke the tool with the `--autocomplete` option, e.g.
```bash
mactime2 --autocomplete bash | sudo tee /etc/bash_completion.d/mactime2
```
would install a autocompletion script in `/etc/bash_completion.d/mactime2`.
# Tools
EOF

Expand Down

0 comments on commit 310ac6c

Please sign in to comment.