summaryrefslogtreecommitdiff
path: root/Components/DisplayFile/metadata.yml
diff options
context:
space:
mode:
Diffstat (limited to 'Components/DisplayFile/metadata.yml')
-rw-r--r--Components/DisplayFile/metadata.yml46
1 files changed, 46 insertions, 0 deletions
diff --git a/Components/DisplayFile/metadata.yml b/Components/DisplayFile/metadata.yml
new file mode 100644
index 0000000..e05d233
--- /dev/null
+++ b/Components/DisplayFile/metadata.yml
@@ -0,0 +1,46 @@
+description: Displays one or multiple file(s) in the terminal
+internal: false
+
+aliases:
+ - cat
+ - type
+ - more
+ - less
+
+manual:
+ summary: |
+ This command displays one or multiple file(s) in the terminal.
+
+ parameters:
+ - name: Pagination
+ description: Enable pagination (scrolling)
+ required: false
+
+ - name: Hex
+ description: Display an hexadecimal dump of the file instead of the contents of the file itself
+ required: false
+
+ - name: Search
+ value: Query
+ description: Search for text in the file(s); does not work with -Pagination
+ required: false
+
+ final:
+ name: File
+ description: The file(s) to display
+ required: true
+ multiple: true
+ command: false
+ path: true
+ daemon: false
+
+ examples:
+ - command: DisplayFile /User/Document.txt
+ description: Display the "Document.txt" file
+
+ - command: DisplayFile -Pagination /User/Essay.txt
+ description: Display the "Essay.txt" file with pagination
+
+ compatibility:
+ mistyos: '>=1.0.0'
+ kernel: '>=5.10.0' \ No newline at end of file