Skip to content

Commit e840956

Browse files
docs: add information on run-schedule command
1 parent 4e4bebb commit e840956

File tree

3 files changed

+30
-5
lines changed

3 files changed

+30
-5
lines changed

docs/content/configuration/logs/_index.md

+8
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,14 @@ profile:
137137
{{% /tab %}}
138138
{{< /tabs >}}
139139

140+
## Priority on the log targets
141+
142+
If specified in different places, here's the priority order for the log destination:
143+
1. `--log` flag on the command line
144+
2. `schedule-log` in the `profile` section
145+
3. `log` in the `global` section
146+
4. default to the console
147+
140148
## Send logs to a temporary file
141149

142150
This can be done by using the [template]({{< ref "/configuration/templates" >}}) function `tempFile`.

docs/content/schedules/commands/index.md

+21-4
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
---
22
title: "Schedule Commands"
33
weight: 20
4+
tags: ["v0.25.0"]
45
---
56

67

78
resticprofile accepts these internal commands:
8-
- `schedule`
9-
- `unschedule`
10-
- `status`
9+
- **schedule**
10+
- **unschedule**
11+
- **status**
1112

12-
All internal commands either operate on the profile selected by `--name`, on the profiles selected by a group, or on all profiles when the flag `--all` is passed.
13+
These resticprofile commands either operate on the profile selected by `--name`, on the profiles selected by a group, or on all profiles when the flag `--all` is passed on the command line.
1314

1415
Examples:
1516
```shell
@@ -39,3 +40,19 @@ Remove all the schedules defined on the selected profile or profiles.
3940
Print the status on all the installed schedules of the selected profile or profiles.
4041

4142
The display of the `status` command will be OS dependant. Please refer to the [examples]({{< ref "/schedules/examples" >}}) on which output you can expect from it.
43+
44+
### run-schedule command
45+
46+
This is the command that is used internally by the scheduler to tell resticprofile to execute in the context of a schedule. It means it will set the proper log output (`schedule-log`) and all other flags specific to the schedule.
47+
48+
If you're scheduling resticprofile manually you can use this command. It will execute the profile using all the `schedule-*` parameters defined in the profile.
49+
50+
This command is only taking one argument: name of the command to execute, followed by the profile name, both separated by a `@` sign.
51+
52+
```shell
53+
resticprofile run-schedule backup@profile
54+
```
55+
56+
{{% notice info %}}
57+
You cannot specify the profile name using the `--name` flag.
58+
{{% /notice %}}

docs/content/schedules/examples/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -356,5 +356,5 @@ If you backup your files to an external repository on a network, you should get
356356
If you prefer not being asked, you can add the `--no-start` flag like so:
357357
358358
```shell
359-
% resticprofile -v -c examples/private/azure.yaml -n self schedule --no-start
359+
resticprofile -v -c examples/private/azure.yaml -n self schedule --no-start
360360
```

0 commit comments

Comments
 (0)