comparison Sphinx/source/users/man-orthanc.txt @ 538:d18496f166b8

documenting the log categories, and manpage of Orthanc
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 05 Nov 2020 15:06:41 +0100
parents
children 4f3a6145ae34
comparison
equal deleted inserted replaced
537:2c8f4eca3cd2 538:d18496f166b8
1 ORTHANC(1) User Commands ORTHANC(1)
2
3 NAME
4 Orthanc - Lightweight, RESTful DICOM server for healthcare and medical
5 research
6
7 SYNOPSIS
8 Orthanc [OPTION]... [CONFIGURATION]
9
10 DESCRIPTION
11 Orthanc, lightweight, RESTful DICOM server for healthcare and medical
12 research.
13
14 The "CONFIGURATION" argument can be a single file or a directory. In
15 the case of a directory, all the JSON files it contains will be merged.
16 If no configuration path is given on the command line, a set of default
17 parameters is used. Please refer to the Orthanc homepage for the full
18 instructions about how to use Orthanc <http://www.orthanc-server.com/>.
19
20 Command-line options:
21 --help display this help and exit
22
23 --logdir=[dir]
24 directory where to store the log files (by default, the log is
25 dumped to stderr)
26
27 --logfile=[file]
28 file where to store the log of Orthanc (by default, the log is
29 dumped to stderr)
30
31 --config=[file]
32 create a sample configuration file and exit (if file is "-",
33 dumps to stdout)
34
35 --errors
36 print the supported error codes and exit
37
38 --verbose
39 be verbose in logs
40
41 --trace
42 highest verbosity in logs (for debug)
43
44 --upgrade
45 allow Orthanc to upgrade the version of the database (beware
46 that the database will become incompatible with former versions
47 of Orthanc)
48
49 --no-jobs
50 Don't restart the jobs that were stored during the last execu‐
51 tion of Orthanc
52
53 --version
54 output version information and exit
55
56 Exit status:
57 0 if success,
58
59 -1 if error (have a look at the logs).
60
61 AUTHOR
62 Written by Sebastien Jodogne <s.jodogne@orthanc-labs.com>
63
64 COPYRIGHT
65 Copyright © 2012-2016 Sebastien Jodogne, Medical Physics Department,
66 University Hospital of Liege (Belgium)
67 Copyright © 2017-2020 Osimis S.A. (Belgium) Licensing GPLv3+: GNU GPL
68 version 3 or later <http://gnu.org/licenses/gpl.html>, with OpenSSL
69 exception.
70 This is free software: you are free to change and redistribute it.
71 There is NO WARRANTY, to the extent permitted by law.
72
73 Orthanc 1.8.0 November 2020 ORTHANC(1)