readme: add 'copy' command
This commit is contained in:
parent
48600584a0
commit
d4daa435e5
23
README.md
23
README.md
|
@ -29,8 +29,9 @@ author: xdrm-brackets
|
||||||
+ [2) Install/remove Packages](#2-installremove-packages)
|
+ [2) Install/remove Packages](#2-installremove-packages)
|
||||||
+ [3) Setup configuration](#3-setup-configuration)
|
+ [3) Setup configuration](#3-setup-configuration)
|
||||||
+ [4) Service management](#4-service-management)
|
+ [4) Service management](#4-service-management)
|
||||||
+ [5) custom scripts](#5-custom-scripts)
|
+ [5) Custom scripts](#5-custom-scripts)
|
||||||
+ [6) Aliases](#6-aliases)
|
+ [6) Copy files](#6-copy-files)
|
||||||
|
+ [7) Aliases](#7-aliases)
|
||||||
* [III. Path Expressions](#iii-path-expressions)
|
* [III. Path Expressions](#iii-path-expressions)
|
||||||
+ [1) Syntax](#1-syntax)
|
+ [1) Syntax](#1-syntax)
|
||||||
+ [2) File Formats](#2-file-formats)
|
+ [2) File Formats](#2-file-formats)
|
||||||
|
@ -146,17 +147,27 @@ Perform the action on services. If more than one, use spaces to separate service
|
||||||
|
|
||||||
#### 5) Custom scripts
|
#### 5) Custom scripts
|
||||||
|
|
||||||
These instructions allow you to use custom scripts for complex operations.
|
This instruction allows you to use custom scripts for complex operations.
|
||||||
|
|
||||||
```
|
```
|
||||||
run <script>
|
run <script>
|
||||||
```
|
```
|
||||||
|
|
||||||
Execute the executable located at the path \<script\>. If script is an [alias](#6-aliases) it will resolve to its path
|
Execute the executable located at the path \<script\>. If script is an [alias](#7-aliases) it will resolve to its path
|
||||||
|
|
||||||
|
#### 6) Copy files
|
||||||
|
|
||||||
|
This instruction allows you to copy files.
|
||||||
|
|
||||||
|
```
|
||||||
|
copy <src> <dst>
|
||||||
|
```
|
||||||
|
|
||||||
|
Try to copy the file \<src\> to the path \<dst\>.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### 6) Aliases
|
#### 7) Aliases
|
||||||
|
|
||||||
The file format allows you to create aliases to file paths for more readability in the [path expression](#ii-path-expressions) or with the [`run` command](#5-custom-scripts).
|
The file format allows you to create aliases to file paths for more readability in the [path expression](#ii-path-expressions) or with the [`run` command](#5-custom-scripts).
|
||||||
|
|
||||||
|
@ -184,7 +195,7 @@ The syntax is pretty fast-forward, it uses 2 levels (file, fields) to find your
|
||||||
|
|
||||||
| Field | Description | Example |
|
| Field | Description | Example |
|
||||||
| --------- | :----------------------------------- | -------------------------- |
|
| --------- | :----------------------------------- | -------------------------- |
|
||||||
| `location_or_alias` | Path to the configuration file to edit. The file will be created if not found. If the path is an [alias](#6-aliases) created before in the file, it will resolve to the alias value as a filename. | `/etc/nginx/nginx.conf`, `some-alias` |
|
| `location_or_alias` | Path to the configuration file to edit. The file will be created if not found. If the path is an [alias](#7-aliases) created before in the file, it will resolve to the alias value as a filename. | `/etc/nginx/nginx.conf`, `some-alias` |
|
||||||
| `fields` | Dot-separated chain of strings that match a configuration field. If the field does not point to a raw field but an existing field container, the \<value\> will replace the group with a text value. | `AllowGroups`, `http.gzip` |
|
| `fields` | Dot-separated chain of strings that match a configuration field. If the field does not point to a raw field but an existing field container, the \<value\> will replace the group with a text value. | `AllowGroups`, `http.gzip` |
|
||||||
|
|
||||||
> The `fields` is processed only for known file formats listed in this [section](#2-file-formats).
|
> The `fields` is processed only for known file formats listed in this [section](#2-file-formats).
|
||||||
|
|
Loading…
Reference in New Issue