Mercurial > hg > orthanc-book
annotate Sphinx/source/users/man-orthanc.txt @ 842:92ca063536ed Orthanc-1.11.0
Orthanc 1.11.0
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 10 May 2022 10:50:15 +0200 |
parents | e95713f90614 |
children | 3e8a3a900e9e |
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 |
842 | 17 parameters is used. Please refer to the Orthanc Book for the full in‐ |
18 structions about how to use Orthanc <http://book.orthanc-server.com/>. | |
554 | 19 |
842 | 20 Pay attention to the fact that the order of the options is important. |
21 Options are read left to right. In particular, options such as "--ver‐ | |
22 bose" can reset the value of other log-related options that were read | |
554 | 23 before. |
24 | |
25 The recommended set of options to debug DICOM communications is "--ver‐ | |
26 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
|
27 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
28 Command-line options: |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
29 --help display this help and exit |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
30 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
31 --logdir=[dir] |
842 | 32 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
|
33 dumped to stderr) |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
34 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
35 --logfile=[file] |
842 | 36 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
|
37 dumped to stderr) |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
38 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
39 --config=[file] |
842 | 40 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
|
41 dumps to stdout) |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
42 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
43 --errors |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
44 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
|
45 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
46 --verbose |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
47 be verbose in logs |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
48 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
49 --trace |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
50 highest verbosity in logs (for debug) |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
51 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
52 --upgrade |
842 | 53 allow Orthanc to upgrade the version of the database (beware |
54 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
|
55 of Orthanc) |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
56 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
57 --no-jobs |
842 | 58 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
|
59 tion of Orthanc |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
60 |
607 | 61 --openapi=[file] |
842 | 62 write the OpenAPI documentation and exit (if "file" is "-", |
607 | 63 dumps to stdout) |
64 | |
65 --cheatsheet=[file] | |
842 | 66 write the cheat sheet of REST API as CSV and exit (if "file" is |
607 | 67 "-", dumps to stdout) |
68 | |
538
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
69 --version |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
70 output version information and exit |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
71 |
554 | 72 Fine-tuning of log categories: |
73 --verbose-generic | |
74 be verbose in logs of category "generic" | |
75 | |
76 --trace-generic | |
77 use highest verbosity for logs of category "generic" | |
78 | |
79 --verbose-plugins | |
80 be verbose in logs of category "plugins" | |
81 | |
82 --trace-plugins | |
83 use highest verbosity for logs of category "plugins" | |
84 | |
85 --verbose-http | |
86 be verbose in logs of category "http" | |
87 | |
88 --trace-http | |
89 use highest verbosity for logs of category "http" | |
90 | |
91 --verbose-sqlite | |
92 be verbose in logs of category "sqlite" | |
93 | |
94 --trace-sqlite | |
95 use highest verbosity for logs of category "sqlite" | |
96 | |
97 --verbose-dicom | |
98 be verbose in logs of category "dicom" | |
99 | |
100 --trace-dicom use highest verbosity for logs of category "dicom" | |
101 | |
102 --verbose-jobs | |
103 be verbose in logs of category "jobs" | |
104 | |
105 --trace-jobs | |
106 use highest verbosity for logs of category "jobs" | |
107 | |
108 --verbose-lua be verbose in logs of category "lua" | |
109 | |
110 --trace-lua | |
111 use highest verbosity for logs of category "lua" | |
112 | |
538
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
113 Exit status: |
554 | 114 0 if success, |
538
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
115 |
554 | 116 -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
|
117 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
118 AUTHOR |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
119 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
|
120 |
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
121 COPYRIGHT |
842 | 122 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
|
123 University Hospital of Liege (Belgium) |
817 | 124 Copyright © 2017-2022 Osimis S.A. (Belgium) |
842 | 125 Copyright © 2021-2022 Sebastien Jodogne, ICTEAM UCLouvain (Belgium) Li‐ |
126 censing GPLv3+: GNU GPL version 3 or later <http://gnu.org/li‐ | |
127 censes/gpl.html>. | |
128 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
|
129 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
|
130 |
842 | 131 Orthanc 1.11.0 May 2022 ORTHANC(1) |