Mercurial > hg > orthanc-book
annotate Sphinx/source/users/man-orthanc.txt @ 945:11d7d30ca273
updated auth plugin doc
| author | Alain Mazy <am@osimis.io> |
|---|---|
| date | Wed, 26 Apr 2023 12:07:30 +0200 |
| parents | a5e7e7001316 |
| children | a6bf749b3c04 |
| 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 |
| 933 | 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/>. | |
| 554 | 20 |
| 933 | 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 | |
| 554 | 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] |
| 933 | 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 | 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 | 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 | 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 |
| 933 | 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 | 62 --openapi=[file] |
| 933 | 63 write the OpenAPI documentation and exit (if "file" is "-", |
| 607 | 64 dumps to stdout) |
| 65 | |
| 66 --cheatsheet=[file] | |
| 933 | 67 write the cheat sheet of REST API as CSV and exit (if "file" is |
| 607 | 68 "-", dumps to stdout) |
| 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 | 73 Fine-tuning of log categories: |
| 74 --verbose-generic | |
| 75 be verbose in logs of category "generic" | |
| 76 | |
| 77 --trace-generic | |
| 78 use highest verbosity for logs of category "generic" | |
| 79 | |
| 80 --verbose-plugins | |
| 81 be verbose in logs of category "plugins" | |
| 82 | |
| 83 --trace-plugins | |
| 84 use highest verbosity for logs of category "plugins" | |
| 85 | |
| 86 --verbose-http | |
| 87 be verbose in logs of category "http" | |
| 88 | |
| 89 --trace-http | |
| 90 use highest verbosity for logs of category "http" | |
| 91 | |
| 92 --verbose-sqlite | |
| 93 be verbose in logs of category "sqlite" | |
| 94 | |
| 95 --trace-sqlite | |
| 96 use highest verbosity for logs of category "sqlite" | |
| 97 | |
| 98 --verbose-dicom | |
| 99 be verbose in logs of category "dicom" | |
| 100 | |
| 101 --trace-dicom use highest verbosity for logs of category "dicom" | |
| 102 | |
| 103 --verbose-jobs | |
| 104 be verbose in logs of category "jobs" | |
| 105 | |
| 106 --trace-jobs | |
| 107 use highest verbosity for logs of category "jobs" | |
| 108 | |
| 109 --verbose-lua be verbose in logs of category "lua" | |
| 110 | |
| 111 --trace-lua | |
| 112 use highest verbosity for logs of category "lua" | |
| 113 | |
|
538
d18496f166b8
documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
114 Exit status: |
| 554 | 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 | 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 |
| 933 | 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) |
| 933 | 125 Copyright © 2017-2023 Osimis S.A. (Belgium) |
| 126 Copyright © 2021-2023 Sebastien Jodogne, ICTEAM UCLouvain (Belgium) | |
| 127 Licensing GPLv3+: GNU GPL version 3 or later | |
| 128 <http://gnu.org/licenses/gpl.html>. | |
| 129 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
|
130 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
|
131 |
| 933 | 132 Orthanc 1.12.0 April 2023 ORTHANC(1) |