Skip to content

Commit

Permalink
Update INPUT_OPTIONS
Browse files Browse the repository at this point in the history
  • Loading branch information
hakavlad committed Jun 22, 2024
1 parent 21dab08 commit c649543
Showing 1 changed file with 24 additions and 24 deletions.
48 changes: 24 additions & 24 deletions docs/INPUT_OPTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This page describes `tird` input options.

---

## \[01] Select an option
## `[01] Select an option`

**Function:** `select_action()`

Expand All @@ -40,43 +40,43 @@ Enter a number and press Enter.

### List of available actions

#### ` 0. Exit `
#### `0. Exit`

Exiting `tird`.

#### ` 1. Info & warnings `
#### `1. Info & warnings`

Displaying info and warnings.

#### ` 2. Encrypt `
#### `2. Encrypt`

Encrypt file contents and comments; write the cryptoblob to a new file.

#### ` 3. Decrypt `
#### `3. Decrypt`

Decrypt a file; display the decrypted comments and write the decrypted contents to a new file.

#### ` 4. Embed `
#### `4. Embed`

Embed file contents (no encryption): write input file contents over output file contents.

#### ` 5. Extract `
#### `5. Extract`

Extract file contents (no decryption) to a new file.

#### ` 6. Encrypt & embed `
#### `6. Encrypt & embed`

Encrypt file contents and comments; write the cryptoblob over a container.

#### ` 7. Extract & decrypt `
#### `7. Extract & decrypt`

Extract and decrypt cryptoblob; display the decrypted comments and write the decrypted contents to a new file.

#### ` 8. Create w/ random `
#### `8. Create w/ random`

Create a file of the specified size with random data.

#### ` 9. Overwrite w/ random `
#### `9. Overwrite w/ random`

Overwrite file contents with random data.

Expand Down Expand Up @@ -120,7 +120,7 @@ I: action #2:

---

## \[02] Use custom settings?
## `[02] Use custom settings?`

**Used in:** actions `2|3|6|7`

Expand Down Expand Up @@ -187,7 +187,7 @@ D: max padding size, %: 100

---

## \[03] Argon2 time cost
## `[03] Argon2 time cost`

**Used in:** actions `2|3|6|7`

Expand All @@ -205,7 +205,7 @@ See [[02] Use custom settings?](#02-use-custom-settings)

---

## \[04] Max padding size
## `[04] Max padding size`

**Used in:** actions `2|3|6|7`

Expand All @@ -223,7 +223,7 @@ See [[02] Use custom settings?](#02-use-custom-settings)

---

## \[05] Set a fake MAC tag?
## `[05] Set a fake MAC tag?`

**Used in:** actions `2|6`

Expand All @@ -241,7 +241,7 @@ See [[02] Use custom settings?](#02-use-custom-settings)

---

## \[06] Input file path
## `[06] Input file path`

**Used in:** actions `2|3|4|5|6|7`

Expand Down Expand Up @@ -340,7 +340,7 @@ D: max_cryptoblob_size: 281540

---

## \[07] Output file path
## `[07] Output file path`

**Used in:** actions `2|3|4|5|6|7|8|9`

Expand Down Expand Up @@ -433,7 +433,7 @@ I: path: "/dev/sdc"; size: 16357785600 B, 15.2 GiB

---

## \[08] Start position
## `[08] Start position`

**Used in:** actions `4|5|6|7|9`

Expand Down Expand Up @@ -468,7 +468,7 @@ I: start position: 0

---

## \[09] End position
## `[09] End position`

**Used in:** actions `5|7|9`

Expand Down Expand Up @@ -504,7 +504,7 @@ I: data size to write: 16357785600 B, 15.2 GiB

---

## \[10] Comments
## `[10] Comments`

**Used in:** actions `2|6`

Expand Down Expand Up @@ -564,7 +564,7 @@ I: comments will be shown as: ["An implementation reference for ChaCha20 has bee

---

## \[11] Keyfile path
## `[11] Keyfile path`

**Used in:** actions `2|3|6|7`

Expand Down Expand Up @@ -733,7 +733,7 @@ I: keyfile accepted

---

## \[12] Passphrase
## `[12] Passphrase`

**Used in:** actions `2|3|6|7`

Expand Down Expand Up @@ -821,7 +821,7 @@ I: entering keying material is completed

---

## \[13] Proceed?
## `[13] Proceed?`

**Used in:** actions `2|3|4|5|6|7|8|9`

Expand Down Expand Up @@ -865,7 +865,7 @@ I: path "fooo" has been removed

---

## \[14] Output file size
## `[14] Output file size`

**Used in:** action `8`

Expand Down

0 comments on commit c649543

Please sign in to comment.