From 925bea444b58d330b013aee46a6a31e7b0b7e9ca Mon Sep 17 00:00:00 2001 From: "Liav A." Date: Fri, 31 May 2024 16:24:04 +0300 Subject: [PATCH] Base: Add a manual page for the shred utility --- Base/usr/share/man/man1/shred.md | 39 ++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 Base/usr/share/man/man1/shred.md diff --git a/Base/usr/share/man/man1/shred.md b/Base/usr/share/man/man1/shred.md new file mode 100644 index 00000000000..8c1def0ac42 --- /dev/null +++ b/Base/usr/share/man/man1/shred.md @@ -0,0 +1,39 @@ +## Name + +shred - destroy a file with its content on disk + +## Synopsis + +```**sh +$ shred [options...] [path...] +``` + +## Description + +`shred` destroys files' content on disk. + +## Options + +* `--help`: Display this message +* `-v`, `--verbose`: Show progress during the shred operation +* `-n`, `--iterations`: Iterations count of shred operation +* `-u`: Deallocate and remove file after overwriting +* `--random-source`: Get random bytes from a file other than /dev/random + +## Arguments + +* `path`: Files to shred + +## Examples + +```sh +# shred a file and remove it aftewards +$ shred -u /tmp/FILE_TO_BE_SHREDDED_AND_REMOVED +# shred a file with 10 iterations +$ shred --iterations 10 /tmp/FILE_TO_BE_SHREDDED +# shred a file with verbose progress and 10 iterations +$ shred -v --iterations 10 /tmp/FILE_TO_BE_SHREDDED +``` + +## See also +* [`rm`(1)](help://man/1/rm) to delete a file or directory without overwriting the content first