summaryrefslogtreecommitdiff
path: root/Components/DisplayFile/metadata.yml
blob: e05d2332f45d5dec9cfc35900d06e643553d1343 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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'