[seiscomp, scanloc] Install, add .gitignore
This commit is contained in:
317
share/man/man1/scsendjournal.1
Normal file
317
share/man/man1/scsendjournal.1
Normal file
@ -0,0 +1,317 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.
|
||||
.nr rst2man-indent-level 0
|
||||
.
|
||||
.de1 rstReportMargin
|
||||
\\$1 \\n[an-margin]
|
||||
level \\n[rst2man-indent-level]
|
||||
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
-
|
||||
\\n[rst2man-indent0]
|
||||
\\n[rst2man-indent1]
|
||||
\\n[rst2man-indent2]
|
||||
..
|
||||
.de1 INDENT
|
||||
.\" .rstReportMargin pre:
|
||||
. RS \\$1
|
||||
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
||||
. nr rst2man-indent-level +1
|
||||
.\" .rstReportMargin post:
|
||||
..
|
||||
.de UNINDENT
|
||||
. RE
|
||||
.\" indent \\n[an-margin]
|
||||
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.nr rst2man-indent-level -1
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SCSENDJOURNAL" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scsendjournal \- SeisComP Documentation
|
||||
.sp
|
||||
\fBSend journaling information to the messaging to manipulate event parameter objects.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
scsendjournal sends journals to the \fIscname\fP messaging system.
|
||||
Currently, journals can be used to command \fI\%scevent\fP\&.
|
||||
The journals command \fI\%scevent\fP to manipulate event parameters according to
|
||||
the \fI\%journal actions\fP which must be known to
|
||||
\fI\%scevent\fP\&.
|
||||
.sp
|
||||
The actions allow to:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Create new events,
|
||||
.IP \(bu 2
|
||||
Modify event parameters,
|
||||
.IP \(bu 2
|
||||
Control the association of origins to events.
|
||||
.UNINDENT
|
||||
.SH ACTIONS
|
||||
.sp
|
||||
There are specific journal actions for handling non\-events and events. The documentation
|
||||
of \fI\%scevent\fP contains a \fI\%complete list of journals known to scevent\fP\&.
|
||||
Parameters used on the command line can also be passed from file using the option
|
||||
\fB\-i\fP\&.
|
||||
.SS None\-event specific actions
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fBEvNewEvent\fP: Create a new event from origin with the provided origin ID.
|
||||
The origin must be known to \fI\%scevent\fP\&.
|
||||
.sp
|
||||
Example: Create a new event from the
|
||||
origin with given originID. Apply the action in the message system on \fIlocalhost\fP:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scsendjournal \-H localhost Origin#20170505130954.736019.318 EvNewEvent
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Origin association
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fBEvGrabOrg\fP: Grab origin and move the origin to the event with the given eventID.
|
||||
If the origins is already associated to another event, remove this reference
|
||||
in the other event.
|
||||
.IP \(bu 2
|
||||
\fBEvMerge\fP: Merge events into one event.
|
||||
.sp
|
||||
Example: Merge all origins from the source event with eventID \fIeventS\fP into the
|
||||
target event with eventID \fIeventT\fP\&. Remove event \fIeventS\fP\&. Apply the action in
|
||||
the message system on \fIhost\fP:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scsendjournal \-H {host} {eventT} EvMerge {eventS}
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
\fBEvSplitOrg\fP: Split origins to 2 events.
|
||||
.UNINDENT
|
||||
.SS Event parameters
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fBEvName\fP: Set \fIEventDescription\fP of type \fIearthquake name\fP\&.
|
||||
.sp
|
||||
Example, setting the name of the event with
|
||||
eventID \fIgempa2021abcd\fP to \fIPetrinja\fP
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scsendjournal \-H localhost gempa2020abcd EvName \(dqPetrinja\(dq
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
\fBEvOpComment\fP: Set event operator\(aqs comment.
|
||||
.IP \(bu 2
|
||||
\fBEvPrefFocMecID\fP: Set event preferred focal mechanism.
|
||||
.IP \(bu 2
|
||||
\fBEvPrefMagTypev:\fP Set preferred magnitude type.
|
||||
.IP \(bu 2
|
||||
\fBEvPrefMw\fP: Set Mw from focal mechanism as preferred magnitude.
|
||||
.IP \(bu 2
|
||||
\fBEvPrefOrgAutomatic\fP: Set the preferred mode to \fIautomatic\fP corresponding to \fIunfix\fP in scolv.
|
||||
.IP \(bu 2
|
||||
\fBEvPrefOrgEvalMode\fP: Set preferred origin by evaluation mode.
|
||||
.IP \(bu 2
|
||||
\fBEvPrefOrgID\fP: Set preferred origin by ID.
|
||||
.IP \(bu 2
|
||||
\fBEvRefresh\fP: Select the preferred origin, the preferred magnitude, update
|
||||
the region. Call processors loaded with plugins, e.g. the
|
||||
\fI\%evrc\fP plugin for scevent.
|
||||
.sp
|
||||
Example:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scsendjournal \-H localhost gempa2021abcd EvRefresh
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
\fBEvType\fP: Set event type.
|
||||
.sp
|
||||
Example: Set the type of the event with eventID \fIgempa2021abcd\fP to \fInuclear explosion\fP\&.
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scsendjournal \-H localhost gempa2021abcd EvType \(dqnuclear explosion\(dq
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
\fBEvTypeCertainty\fP: set event type certainty.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscsendjournal [opts] {objectID} {action} [parameters]\fP
|
||||
.SS Generic
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-h, \-\-help
|
||||
Show help message.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-V, \-\-version
|
||||
Show version information.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-config\-file arg
|
||||
Use alternative configuration file. When this option is
|
||||
used the loading of all stages is disabled. Only the
|
||||
given configuration file is parsed and used. To use
|
||||
another name for the configuration create a symbolic
|
||||
link of the application or copy it. Example:
|
||||
scautopick \-> scautopick2.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-plugins arg
|
||||
Load given plugins.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-D, \-\-daemon
|
||||
Run as daemon. This means the application will fork itself
|
||||
and doesn\(aqt need to be started with &.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-auto\-shutdown arg
|
||||
Enable/disable self\-shutdown because a master module shutdown.
|
||||
This only works when messaging is enabled and the master
|
||||
module sends a shutdown message (enabled with \-\-start\-stop\-msg
|
||||
for the master module).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-shutdown\-master\-module arg
|
||||
Set the name of the master\-module used for auto\-shutdown.
|
||||
This is the application name of the module actually
|
||||
started. If symlinks are used, then it is the name of
|
||||
the symlinked application.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-shutdown\-master\-username arg
|
||||
Set the name of the master\-username of the messaging
|
||||
used for auto\-shutdown. If \(dqshutdown\-master\-module\(dq is
|
||||
given as well, this parameter is ignored.
|
||||
.UNINDENT
|
||||
.SS Verbosity
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-verbosity arg
|
||||
Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
|
||||
4:debug.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-v, \-\-v
|
||||
Increase verbosity level (may be repeated, eg. \-vv).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-q, \-\-quiet
|
||||
Quiet mode: no logging output.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-component arg
|
||||
Limit the logging to a certain component. This option can
|
||||
be given more than once.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-s, \-\-syslog
|
||||
Use syslog logging backend. The output usually goes to
|
||||
/var/lib/messages.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-l, \-\-lockfile arg
|
||||
Path to lock file.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-console arg
|
||||
Send log output to stdout.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-debug
|
||||
Execute in debug mode.
|
||||
Equivalent to \-\-verbosity=4 \-\-console=1 .
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-log\-file arg
|
||||
Use alternative log file.
|
||||
.UNINDENT
|
||||
.SS Messaging
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-u, \-\-user arg
|
||||
Overrides configuration parameter \fI\%connection.username\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-H, \-\-host arg
|
||||
Overrides configuration parameter \fI\%connection.server\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-t, \-\-timeout arg
|
||||
Overrides configuration parameter \fI\%connection.timeout\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-g, \-\-primary\-group arg
|
||||
Overrides configuration parameter \fI\%connection.primaryGroup\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-S, \-\-subscribe\-group arg
|
||||
A group to subscribe to.
|
||||
This option can be given more than once.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-start\-stop\-msg arg
|
||||
Set sending of a start and a stop message.
|
||||
.UNINDENT
|
||||
.SS Input
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-i, \-\-input arg
|
||||
Read parameters from given file instead from command line.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
Reference in New Issue
Block a user