Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Writing readme #3

Merged
merged 30 commits into from
Dec 22, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
readme wip
garikello3d committed Dec 21, 2023
commit 678ffd2265aa42daf877a9f8e5b24b089caf1262
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -40,9 +40,9 @@ Finally, additional assurance is maintaned since the integrity of resulting file
</tbody>
</table>

| Option &#xA0C2;&#xA0C2;&#xA0C2;&#xA0C2;&#xA0C2;&#xA0C2;&#xA0C2;&#xA0C2;&#xA0C2;&#xA0C2;&#xA0C2;&#xA0C2;&#xA0C2;&#xA0C2;&#xA0C2;&#xA0C2;&#xA0C2;&#xA0C2;&#xA0C2;&#xA0C2;&#xA0C2; | Meaning |
|------------------------|---------|
| --buf-size <size_MB> | buffer size to use when reading or writing (see _Memory usage_ section below for details) |
| Option                     | Meaning |
|----------------------------|---------|
| `--buf-size <size_MB>` | buffer size to use when reading or writing (see _Memory usage_ section below for details) |
| `--pass <password>` | password for encryption or decryption<br/>**WARNING:** it's impossible to restore the archive if password is lost! |
| `--auth <auth_string>` | any arbitrary public authentication string that will be embedded into to archive; can be someone's name or passport ID, or company name; it's not kept in secret, but an attacker won't be able to impersonate this string |
| `--auth-every <size_MB>` | how frequent to insert the authentication string; any reasonble value around dozens of megabytes is ok |