Work on documentation.
[monikop.git] / monikop.config.example
blob8e772d2022c153b0112d6ae4eaf875dd49fcd121
1 # -*- perl -*-
2 #############################################################
3 # Monikop Settings
5 # Copy this file to monikop.config and adapt it to your needs.
6 ##############################################################
7 # Possible data sources, and by what directory name to represent them in
8 # destination.
9 # When the latter is not unique, care must be taken that all pathnames in the 
10 # respective sources are unique.
11 %sources = (
12     'data_producer1::data' => 'p1',
13     'data_producer2::data' => 'p2',
14     'data_producer3::data' => '',
15     'data_producer4::data' => '',
16     );
18 # Possible mount points of data destinations. Must be unique.
19 @usable_mount_points = (
20     '/media/disk_1',
21     '/media/disk_2',
22     '/media/disk_3',
23     );
25 # Common directory (under a mount point) to put new data in.
26 # Must agree with Pokinom's setting.
27 $path_in_destination =
28     'measuring_data'
29     ;
31 # Directories (under any mount point) of this name will be deleted
32 # Must agree with Pokinom's setting.
33 $path_in_destination_backed_up =
34     'backed_up'
35     ;
37 # Directory name (under a mount point) while being deleted.
38 # Must agree with Pokinom's setting.
39 $path_in_destination_being_deleted =
40     'being_deleted'
41     ;
43 # Path and file name prefix of rsync's raw logs:
44 $rsync_log_prefix =
45     '/tmp/monikop/log.'
46     ;
48 # Path and file name prefix of the list of successfully rsynced files:
49 $finished_prefix =
50     '/tmp/monikop/finished.'
51     ; 
53 # How to suffix the name of the duplicate of a safe file:
54 $safe_file_backup_suffix =
55     '.bak'
56     ; 
58 # How to suffix the name of an unfinished safe file:
59 $safe_file_unfinished_suffix =
60     '.unfinished'
61     ; 
63 # What to do (shutdown) when F3 has been pressed:
64 $key_f3_action =
65     "sudo halt -p"
66     ;
68 # What to do (reboot) when F6 has been pressed:
69 $key_f6_action =
70     "sudo reboot"
71     ;
73 # Rsyncs time (in seconds) to wait for a response:
74 $rsync_timeout =
75     30
76     ;
78 # Rsyncs directory (relative to destination) for partially transferred files.
79 # Must agree with Pokinom's setting.
80 $rsync_partial_dir_name =
81     '.rsync_partial'
82     ;