Merge branch 'master' into cadet_option
[oweals/gnunet.git] / doc / man / gnunet-datastore.1
1 .\" This file is part of GNUnet.
2 .\" Copyright (C) 2001-2019 GNUnet e.V.
3 .\"
4 .\" Permission is granted to copy, distribute and/or modify this document
5 .\" under the terms of the GNU Free Documentation License, Version 1.3 or
6 .\" any later version published by the Free Software Foundation; with no
7 .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
8 .\" copy of the license is included in the file
9 .\" FDL-1.3.
10 .\"
11 .\" A copy of the license is also available from the Free Software
12 .\" Foundation Web site at http://www.gnu.org/licenses/fdl.html.
13 .\"
14 .\" Alternately, this document is also available under the General
15 .\" Public License, version 3 or later, as published by the Free Software
16 .\" Foundation.  A copy of the license is included in the file
17 .\" GPL3.
18 .\"
19 .\" A copy of the license is also available from the Free Software
20 .\" Foundation Web site at http://www.gnu.org/licenses/gpl.html.
21 .\"
22 .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23 .\"
24 .Dd April 13, 2017
25 .Dt GNUNET-DATASTORE 1
26 .Os
27 .Sh NAME
28 .Nm gnunet-datastore
29 .Nd dump or insert (restore) GNUnet datastore databases
30 .Sh SYNOPSIS
31 .Nm
32 .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
33 .Op Fl d | -dump
34 .Op Fl f Ar FILENAME | Fl \-file= Ns Ar FILENAME
35 .Op Fl h | -help
36 .Op Fl i | -insert
37 .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
38 .Op Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME
39 .Op Fl v | -version
40 .Sh DESCRIPTION
41 .Nm
42 can be used to backup and restore or merge GNUnet datastores.
43 This is useful if a datastore is to be migrated between
44 SQL databases, i.e. from sqlite to postgres or vice versa.
45 gnunet-datastore will dump the entire contents of the database
46 or insert a dump file into the database.
47 .Bl -tag -width indent
48 .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
49 Configuration file to use
50 .It Fl d | -dump
51 Dump all records to a file
52 .It Fl f Ar FILENAME | Fl -file= Ns Ar FILENAME
53 File to dump to or insert from.
54 Otherwise stdin/stdout are used.
55 .It Fl h | -help
56 Print the help page.
57 .It Fl i | -insert
58 Insert from dump file.
59 .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
60 Change the loglevel.
61 Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
62 .It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME
63 Configure logging to write logs to FILENAME
64 .It Fl v | -version
65 Print the version number
66 .El
67 .\".Sh EXAMPLES
68 .Sh SEE ALSO
69 .Xr gnunet-publish 1
70 .Pp
71 The full documentation for gnunet is maintained as a Texinfo manual.
72 If the
73 .Xr info 1
74 and gnunet programs are properly installed at your site, the command
75 .Pp
76 .Dl info gnunet
77 .Pp
78 should give you access to the complete handbook,
79 .Pp
80 .Dl info gnunet-c-tutorial
81 .Pp
82 will give you access to a tutorial for developers.
83 .sp
84 Depending on your installation, this information is also available in
85 .Xr gnunet 7 and
86 .Xr gnunet-c-tutorial 7 .
87 .\".Sh HISTORY
88 .\".Sh AUTHORS
89 .Sh BUGS
90 Report bugs by using
91 .Lk https://bugs.gnunet.org
92 or by sending electronic mail to
93 .Aq Mt gnunet-developers@gnu.org .