summaryrefslogtreecommitdiff
path: root/Base/usr
diff options
context:
space:
mode:
authornetworkException <git@nwex.de>2021-12-19 16:57:28 +0100
committerBrian Gianforcaro <b.gianfo@gmail.com>2021-12-19 11:03:29 -0800
commit121bcc267dc19f474254f68a70850f0806e3385f (patch)
treee513888a6826f02904203a469b3d68abdf72ade6 /Base/usr
parente0521cfb9d2d82bc2f99f39c132db4a0a082ac55 (diff)
downloadserenity-121bcc267dc19f474254f68a70850f0806e3385f.zip
Base: Add rm(1) manpage
Diffstat (limited to 'Base/usr')
-rw-r--r--Base/usr/share/man/man1/rm.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/Base/usr/share/man/man1/rm.md b/Base/usr/share/man/man1/rm.md
new file mode 100644
index 0000000000..9800244d1a
--- /dev/null
+++ b/Base/usr/share/man/man1/rm.md
@@ -0,0 +1,31 @@
+## Name
+
+rm - Remove files
+
+## Synopsis
+
+```**sh
+$ rm [options...] <path...>
+```
+
+## Description
+
+`rm` removes files specified in `path`.
+
+If a directory is specified in `path`, the `-r` (recursive) flag is required. Otherwise, an error occurs.
+
+## Options
+
+* `-r`, `--recursive`: Remove files and directories recursively
+* `-f`, `--force`: Do not prompt before removing
+* `-v`, `--verbose`: Display what files are removed
+
+## Examples
+
+```sh
+# Remove README.md file
+$ rm README.md
+
+# Remove cpp-tests directory
+$ rm -r cpp-tests
+```