Mercurial > hg > orthanc-book

annotate Sphinx/source/users/man-orthanc.txt @ 877:900033cffeb2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
loosened sanity checks for modifications
author Alain Mazy <am@osimis.io>
date Mon, 26 Sep 2022 19:13:38 +0200
parents 3e8a3a900e9e
children a5e7e7001316
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
842
92ca063536ed Orthanc 1.11.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 825
diff changeset
17 parameters is used. Please refer to the Orthanc Book for the full in‐
92ca063536ed Orthanc 1.11.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 825
diff changeset
18 structions about how to use Orthanc <http://book.orthanc-server.com/>.
554
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
19
842
92ca063536ed Orthanc 1.11.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 825
diff changeset
20 Pay attention to the fact that the order of the options is important.
92ca063536ed Orthanc 1.11.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 825
diff changeset
21 Options are read left to right. In particular, options such as "--ver‐
92ca063536ed Orthanc 1.11.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 825
diff changeset
22 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
23 before.
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
24
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
25 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
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
92ca063536ed Orthanc 1.11.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 825
diff changeset
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
92ca063536ed Orthanc 1.11.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 825
diff changeset
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
92ca063536ed Orthanc 1.11.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 825
diff changeset
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
92ca063536ed Orthanc 1.11.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 825
diff changeset
53 allow Orthanc to upgrade the version of the database (beware
92ca063536ed Orthanc 1.11.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 825
diff changeset
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
92ca063536ed Orthanc 1.11.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 825
diff changeset
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
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 568
diff changeset
61 --openapi=[file]
842
92ca063536ed Orthanc 1.11.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 825
diff changeset
62 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
63 dumps to stdout)
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 568
diff changeset
64
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 568
diff changeset
65 --cheatsheet=[file]
842
92ca063536ed Orthanc 1.11.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 825
diff changeset
66 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
67 "-", dumps to stdout)
eaa6cdfa7ba6 Orthanc 1.9.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 568
diff changeset
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
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
72 Fine-tuning of log categories:
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
73 --verbose-generic
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
74 be verbose in logs of category "generic"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
75
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
76 --trace-generic
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
77 use highest verbosity for logs of category "generic"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
78
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
79 --verbose-plugins
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
80 be verbose in logs of category "plugins"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
81
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
82 --trace-plugins
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
83 use highest verbosity for logs of category "plugins"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
84
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
85 --verbose-http
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
86 be verbose in logs of category "http"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
87
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
88 --trace-http
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
89 use highest verbosity for logs of category "http"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
90
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
91 --verbose-sqlite
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
92 be verbose in logs of category "sqlite"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
93
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
94 --trace-sqlite
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
95 use highest verbosity for logs of category "sqlite"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
96
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
97 --verbose-dicom
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
98 be verbose in logs of category "dicom"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
99
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
100 --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
101
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
102 --verbose-jobs
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
103 be verbose in logs of category "jobs"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
104
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
105 --trace-jobs
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
106 use highest verbosity for logs of category "jobs"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
107
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
108 --verbose-lua be verbose in logs of category "lua"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
109
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
110 --trace-lua
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
111 use highest verbosity for logs of category "lua"
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
112
538
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113 Exit status:
554
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
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
4f3a6145ae34 Orthanc 1.8.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 538
diff changeset
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
92ca063536ed Orthanc 1.11.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 825
diff changeset
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
01fa632daae9 Orthanc 1.10.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 763
diff changeset
124 Copyright © 2017-2022 Osimis S.A. (Belgium)
842
92ca063536ed Orthanc 1.11.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 825
diff changeset
125 Copyright © 2021-2022 Sebastien Jodogne, ICTEAM UCLouvain (Belgium) Li‐
92ca063536ed Orthanc 1.11.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 825
diff changeset
126 censing GPLv3+: GNU GPL version 3 or later <http://gnu.org/li‐
92ca063536ed Orthanc 1.11.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 825
diff changeset
127 censes/gpl.html>.
92ca063536ed Orthanc 1.11.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 825
diff changeset
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
860
3e8a3a900e9e Orthanc 1.11.1
Alain Mazy <am@osimis.io>
parents: 842
diff changeset
131 Orthanc 1.11.1 June 2022 ORTHANC(1)