Mercurial > hg > orthanc-book
annotate Sphinx/source/users/man-orthanc.txt @ 554:4f3a6145ae34
Orthanc 1.8.1
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Mon, 07 Dec 2020 17:48:33 +0100 |
parents | d18496f166b8 |
children | 090cc988c35e |
rev | line source |
---|---|
538
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1 ORTHANC(1) User Commands ORTHANC(1) |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
3 NAME |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
4 Orthanc - Lightweight, RESTful DICOM server for healthcare and medical |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
5 research |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
6 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
7 SYNOPSIS |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
8 Orthanc [OPTION]... [CONFIGURATION] |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
9 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
10 DESCRIPTION |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
11 Orthanc, lightweight, RESTful DICOM server for healthcare and medical |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
12 research. |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
13 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
14 The "CONFIGURATION" argument can be a single file or a directory. In |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
15 the case of a directory, all the JSON files it contains will be merged. |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
16 If no configuration path is given on the command line, a set of default |
554 | 17 parameters is used. Please refer to the Orthanc Book for the full |
18 instructions about how to use Orthanc | |
19 <http://book.orthanc-server.com/>. | |
20 | |
21 Pay attention to the fact that the order of the options is important. | |
22 Options are read left to right. In particular, options such as "--ver‐ | |
23 bose" can reset the value of other log-related options that were read | |
24 before. | |
25 | |
26 The recommended set of options to debug DICOM communications is "--ver‐ | |
27 bose --trace-dicom --logfile=dicom.log" | |
538
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
28 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
29 Command-line options: |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
30 --help display this help and exit |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
31 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
32 --logdir=[dir] |
554 | 33 directory where to store the log files (by default, the log is |
538
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
34 dumped to stderr) |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
35 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
36 --logfile=[file] |
554 | 37 file where to store the log of Orthanc (by default, the log is |
538
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
38 dumped to stderr) |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
39 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
40 --config=[file] |
554 | 41 create a sample configuration file and exit (if "file" is "-", |
538
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
42 dumps to stdout) |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
43 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
44 --errors |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
45 print the supported error codes and exit |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
46 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
47 --verbose |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
48 be verbose in logs |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
49 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
50 --trace |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
51 highest verbosity in logs (for debug) |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
52 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
53 --upgrade |
554 | 54 allow Orthanc to upgrade the version of the database (beware |
55 that the database will become incompatible with former versions | |
538
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
56 of Orthanc) |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
57 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
58 --no-jobs |
554 | 59 Don't restart the jobs that were stored during the last execu‐ |
538
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
60 tion of Orthanc |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
61 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
62 --version |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
63 output version information and exit |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
64 |
554 | 65 Fine-tuning of log categories: |
66 --verbose-generic | |
67 be verbose in logs of category "generic" | |
68 | |
69 --trace-generic | |
70 use highest verbosity for logs of category "generic" | |
71 | |
72 --verbose-plugins | |
73 be verbose in logs of category "plugins" | |
74 | |
75 --trace-plugins | |
76 use highest verbosity for logs of category "plugins" | |
77 | |
78 --verbose-http | |
79 be verbose in logs of category "http" | |
80 | |
81 --trace-http | |
82 use highest verbosity for logs of category "http" | |
83 | |
84 --verbose-sqlite | |
85 be verbose in logs of category "sqlite" | |
86 | |
87 --trace-sqlite | |
88 use highest verbosity for logs of category "sqlite" | |
89 | |
90 --verbose-dicom | |
91 be verbose in logs of category "dicom" | |
92 | |
93 --trace-dicom use highest verbosity for logs of category "dicom" | |
94 | |
95 --verbose-jobs | |
96 be verbose in logs of category "jobs" | |
97 | |
98 --trace-jobs | |
99 use highest verbosity for logs of category "jobs" | |
100 | |
101 --verbose-lua be verbose in logs of category "lua" | |
102 | |
103 --trace-lua | |
104 use highest verbosity for logs of category "lua" | |
105 | |
538
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
106 Exit status: |
554 | 107 0 if success, |
538
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
108 |
554 | 109 -1 if error (have a look at the logs). |
538
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
110 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
111 AUTHOR |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
112 Written by Sebastien Jodogne <s.jodogne@orthanc-labs.com> |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
113 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
114 COPYRIGHT |
554 | 115 Copyright © 2012-2016 Sebastien Jodogne, Medical Physics Department, |
538
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
116 University Hospital of Liege (Belgium) |
554 | 117 Copyright © 2017-2020 Osimis S.A. (Belgium) Licensing GPLv3+: GNU GPL |
118 version 3 or later <http://gnu.org/licenses/gpl.html>, with OpenSSL | |
538
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
119 exception. |
554 | 120 This is free software: you are free to change and redistribute it. |
538
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
121 There is NO WARRANTY, to the extent permitted by law. |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
122 |
554 | 123 Orthanc 1.8.1 December 2020 ORTHANC(1) |