.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.3.
.TH ORTHANC "8" "July 2021" "Orthanc 1.9.6" "System Administration Utilities"
.SH NAME
Orthanc \- Lightweight, RESTful DICOM server for healthcare and medical research
.SH SYNOPSIS
.B Orthanc
[\fI\,OPTION\/\fR]... [\fI\,CONFIGURATION\/\fR]
.SH DESCRIPTION
Orthanc, lightweight, RESTful DICOM server for healthcare and medical research.
.PP
The "CONFIGURATION" argument can be a single file or a directory. In the
case of a directory, all the JSON files it contains will be merged.
If no configuration path is given on the command line, a set of default
parameters is used. Please refer to the Orthanc Book for the full
instructions about how to use Orthanc <http://book.orthanc\-server.com/>.
.PP
Pay attention to the fact that the order of the options is important.
Options are read left to right. In particular, options such as "\-\-verbose" can
reset the value of other log\-related options that were read before.
.PP
The recommended set of options to debug DICOM communications is
"\-\-verbose \fB\-\-trace\-dicom\fR \fB\-\-logfile\fR=\fI\,dicom\/\fR.log"
.SS "Command-line options:"
.TP
\fB\-\-help\fR
display this help and exit
.TP
\fB\-\-logdir\fR=\fI\,[dir]\/\fR
directory where to store the log files
(by default, the log is dumped to stderr)
.TP
\fB\-\-logfile\fR=\fI\,[file]\/\fR
file where to store the log of Orthanc
(by default, the log is dumped to stderr)
.TP
\fB\-\-config\fR=\fI\,[file]\/\fR
create a sample configuration file and exit
(if "file" is "\-", dumps to stdout)
.TP
\fB\-\-errors\fR
print the supported error codes and exit
.TP
\fB\-\-verbose\fR
be verbose in logs
.TP
\fB\-\-trace\fR
highest verbosity in logs (for debug)
.TP
\fB\-\-upgrade\fR
allow Orthanc to upgrade the version of the
database (beware that the database will become
incompatible with former versions of Orthanc)
.TP
\fB\-\-no\-jobs\fR
don't restart the jobs that were stored during
the last execution of Orthanc
.TP
\fB\-\-openapi\fR=\fI\,[file]\/\fR
write the OpenAPI documentation and exit
(if "file" is "\-", dumps to stdout)
.TP
\fB\-\-cheatsheet\fR=\fI\,[file]\/\fR
write the cheat sheet of REST API as CSV
and exit (if "file" is "\-", dumps to stdout)
.TP
\fB\-\-version\fR
output version information and exit
.SS "Fine-tuning of log categories:"
.TP
\fB\-\-verbose\-generic\fR
be verbose in logs of category "generic"
.TP
\fB\-\-trace\-generic\fR
use highest verbosity for logs of category "generic"
.TP
\fB\-\-verbose\-plugins\fR
be verbose in logs of category "plugins"
.TP
\fB\-\-trace\-plugins\fR
use highest verbosity for logs of category "plugins"
.TP
\fB\-\-verbose\-http\fR
be verbose in logs of category "http"
.TP
\fB\-\-trace\-http\fR
use highest verbosity for logs of category "http"
.TP
\fB\-\-verbose\-sqlite\fR
be verbose in logs of category "sqlite"
.TP
\fB\-\-trace\-sqlite\fR
use highest verbosity for logs of category "sqlite"
.TP
\fB\-\-verbose\-dicom\fR
be verbose in logs of category "dicom"
.HP
\fB\-\-trace\-dicom\fR use highest verbosity for logs of category "dicom"
.TP
\fB\-\-verbose\-jobs\fR
be verbose in logs of category "jobs"
.TP
\fB\-\-trace\-jobs\fR
use highest verbosity for logs of category "jobs"
.HP
\fB\-\-verbose\-lua\fR be verbose in logs of category "lua"
.TP
\fB\-\-trace\-lua\fR
use highest verbosity for logs of category "lua"
.SS "Exit status:"
.TP
0
if success,
.TP
\fB\-1\fR
if error (have a look at the logs).
.SH AUTHOR
Written by Sebastien Jodogne <s.jodogne@orthanc\-labs.com>
.SH COPYRIGHT
Copyright \(co 2012\-2016 Sebastien Jodogne, Medical Physics Department, University Hospital of Liege (Belgium)
.br
Copyright \(co 2017\-2021 Osimis S.A. (Belgium)
Licensing GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>, with OpenSSL exception.
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.