Mercurial > hg > orthanc-book

annotate Sphinx/source/users/man-orthanc.txt @ 1113:a588960a72e5 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
spelling
author Alain Mazy <am@orthanc.team>
date Mon, 28 Oct 2024 09:23:08 +0100
parents d2be251975d1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
1021
a3436ae3709c Orthanc 1.12.3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 991
diff changeset
17 parameters is used. Please refer to the Orthanc Book for the full in‐
a3436ae3709c Orthanc 1.12.3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 991
diff changeset
18 structions about how to use Orthanc <https://orthanc.uclou‐
a3436ae3709c Orthanc 1.12.3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 991
diff changeset
19 vain.be/book/>.
554
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
20
933
a5e7e7001316 Orthanc 1.12.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 860
diff changeset
21 Pay attention to the fact that the order of the options is important.
a5e7e7001316 Orthanc 1.12.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 860
diff changeset
22 Options are read left to right. In particular, options such as "--ver‐
a5e7e7001316 Orthanc 1.12.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 860
diff changeset
23 bose" can reset the value of other log-related options that were read
554
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
24 before.
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
25
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
26 The recommended set of options to debug DICOM communications is "--ver‐
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
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]
933
a5e7e7001316 Orthanc 1.12.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 860
diff changeset
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]
933
a5e7e7001316 Orthanc 1.12.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 860
diff changeset
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]
933
a5e7e7001316 Orthanc 1.12.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 860
diff changeset
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
933
a5e7e7001316 Orthanc 1.12.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 860
diff changeset
54 allow Orthanc to upgrade the version of the database (beware
a5e7e7001316 Orthanc 1.12.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 860
diff changeset
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
933
a5e7e7001316 Orthanc 1.12.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 860
diff changeset
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
607
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 568
diff changeset
62 --openapi=[file]
1021
a3436ae3709c Orthanc 1.12.3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 991
diff changeset
63 write the OpenAPI documentation and exit (if "file" is "-",
607
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 568
diff changeset
64 dumps to stdout)
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 568
diff changeset
65
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 568
diff changeset
66 --cheatsheet=[file]
933
a5e7e7001316 Orthanc 1.12.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 860
diff changeset
67 write the cheat sheet of REST API as CSV and exit (if "file" is
607
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 568
diff changeset
68 "-", dumps to stdout)
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 568
diff changeset
69
538
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 --version
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 output version information and exit
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72
554
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
73 Fine-tuning of log categories:
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
74 --verbose-generic
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
75 be verbose in logs of category "generic"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
76
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
77 --trace-generic
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
78 use highest verbosity for logs of category "generic"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
79
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
80 --verbose-plugins
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
81 be verbose in logs of category "plugins"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
82
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
83 --trace-plugins
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
84 use highest verbosity for logs of category "plugins"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
85
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
86 --verbose-http
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
87 be verbose in logs of category "http"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
88
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
89 --trace-http
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
90 use highest verbosity for logs of category "http"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
91
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
92 --verbose-sqlite
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
93 be verbose in logs of category "sqlite"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
94
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
95 --trace-sqlite
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
96 use highest verbosity for logs of category "sqlite"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
97
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
98 --verbose-dicom
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
99 be verbose in logs of category "dicom"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
100
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
101 --trace-dicom use highest verbosity for logs of category "dicom"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
102
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
103 --verbose-jobs
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
104 be verbose in logs of category "jobs"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
105
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
106 --trace-jobs
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
107 use highest verbosity for logs of category "jobs"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
108
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
109 --verbose-lua be verbose in logs of category "lua"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
110
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
111 --trace-lua
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
112 use highest verbosity for logs of category "lua"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
113
538
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 Exit status:
554
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
115 0 if success,
538
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116
554
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
117 -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
118
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119 AUTHOR
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
120 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
121
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122 COPYRIGHT
1021
a3436ae3709c Orthanc 1.12.3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 991
diff changeset
123 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
124 University Hospital of Liege (Belgium)
1075
d2be251975d1 Orthanc 1.12.4
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1021
diff changeset
125 Copyright © 2017-2023 Osimis S.A. (Belgium)
d2be251975d1 Orthanc 1.12.4
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1021
diff changeset
126 Copyright © 2024-2024 Orthanc Team SRL (Belgium)
1021
a3436ae3709c Orthanc 1.12.3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 991
diff changeset
127 Copyright © 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain (Belgium) Li‐
a3436ae3709c Orthanc 1.12.3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 991
diff changeset
128 censing GPLv3+: GNU GPL version 3 or later <http://gnu.org/li‐
a3436ae3709c Orthanc 1.12.3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 991
diff changeset
129 censes/gpl.html>.
a3436ae3709c Orthanc 1.12.3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 991
diff changeset
130 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
131 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
132
1075
d2be251975d1 Orthanc 1.12.4
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1021
diff changeset
133 Orthanc 1.12.4 June 2024 ORTHANC(1)