-
Notifications
You must be signed in to change notification settings - Fork 3
/
hpct-sync.1
90 lines (90 loc) · 4.14 KB
/
hpct-sync.1
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
.\" ========================================================================
.\" _ _ _ ____ ____ _____
.\" | | | (_) _ \ ___ _ __ / ___|___ _ _|_ _| __ __ _ ___ ___ _ __
.\" | |_| | | |_) / _ \ '__| | / _ \| '_ \| || '__/ _` |/ __/ _ \ '__|
.\" | _ | | __/ __/ | | |__| (_) | | | | || | | (_| | (_| __/ |
.\" |_| |_|_|_| \___|_| \____\___/|_| |_|_||_| \__,_|\___\___|_|
.\"
.\" --- High-Performance Connectivity Tracer (HiPerConTracer) ---
.\" https://www.nntb.no/~dreibh/hipercontracer/
.\" ========================================================================
.\"
.\" High-Performance Connectivity Tracer (HiPerConTracer)
.\" Copyright (C) 2015-2025 by Thomas Dreibholz
.\"
.\" This program is free software: you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation, either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
.\"
.\" Contact: dreibh@simula.no
.\"
.\" ###### Setup ############################################################
.Dd December 19, 2024
.Dt hpct-sync 1
.Os hpct-sync
.\" ###### Name #############################################################
.Sh NAME
.Nm hpct-sync
.Nd HiPerConTracer Synchroniser
.\" ###### Synopsis #########################################################
.Sh SYNOPSIS
.Nm hpct-sync
.Op Fl h | Fl Fl help
.Op Fl v | Fl Fl verbose
.Op Fl q | Fl Fl quiet
.Op Fl N Ar node_id | Fl Fl nodeid Ar node_id
.Op Fl L Ar local_directory | Fl Fl local Ar local_directory
.Op Fl R Ar remote_location | Fl Fl remote Ar remote_location
.Op Fl C | Fl Fl collector collector
.Op Fl K Ar ssh_private_key_file | Fl Fl key Ar ssh_private_key_file
.Op Fl H Ar ssh_known_hosts_file | Fl Fl known-hosts Ar ssh_known_hosts_file
.\" ###### Description ######################################################
.Sh DESCRIPTION
.Nm hpct-sync
is the HiPerConTracer synchroniser application.
.Pp
.\" ###### Arguments ########################################################
.Sh ARGUMENTS
The following arguments may be provided:
.Bl -tag -width indent
.It Fl h | Fl Fl help
Prints command help.
.It Fl q | Fl Fl quiet
Turns off status output.
.It Fl v | Fl Fl verbose
Turns on status output.
.It Fl N Ar node_id | Fl Fl nodeid Ar node_id
Sets the node ID, a number from 1 to 9999.
.It Fl L Ar local_directory | Fl Fl local Ar local_directory
Sets the local data directory. Default: /var/hipercontracer/data.
.It Fl R Ar remote_location | Fl Fl remote Ar remote_location
Sets the remote data directory on the collector. Default: /var/hipercontracer/data.
.It Fl K Ar ssh_private_key_file | Fl Fl key Ar ssh_private_key_file
Sets the SSH private key file used for authentication. Default: /var/hipercontracer/ssh/id_ed25519.
.It Fl H Ar ssh_known_hosts_file | Fl Fl known-hosts Ar ssh_known_hosts_file
Sets the SSH known hosts file. Default: /var/hipercontracer/ssh/known_hosts.
.El
.\" ###### Examples #########################################################
.Sh EXAMPLES
.Bl -tag -width indent
.It sudo -u hipercontracer hpct-sync --nodeid 1000 --local /var/hipercontracer --remote /var/hipercontracer --collector sognsvann.example --key /var/hipercontracer/ssh/id_ed25519 --known-hosts /var/hipercontracer/ssh/known_hosts --verbose
.It sudo -u hipercontracer hpct-sync --nodeid 1 --local /var/hipercontracer --remote /var/hipercontracer --collector sognsvann.example --key /var/hipercontracer/ssh/id_ed25519 --known-hosts /var/hipercontracer/ssh/known_hosts --quiet
.It sudo -u hipercontracer hpct-sync --nodeid 2 --collector sognsvann.example
.El
.\" ###### Authors ##########################################################
.Sh AUTHORS
Thomas Dreibholz
.br
https://www.simula.no/people/dreibh
.br
mailto://dreibh@simula.no
.br