Difference between revisions of "Melog"

From MidasWiki
Jump to navigation Jump to search
Line 1: Line 1:
== Description ==
+
{{Pagelinks}}
The <span style="color:darkcyan;">''melog''</span> utility submits an entry to the [https://midas.psi.ch/elog/ ELOG (electronic log)]. See also mhttpd [[ELOG Page]].
 
  
<span style="color:darkcyan;">''melog''</span> is used to submit full Elog entry to the specified Elog port.
+
= Links =
 +
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* [[/Elog ODB tree]]
 +
* [[Elog Page]]
 +
* [[Electronic Logbook (ELOG)]]
 +
</div>
 +
== Purpose ==
 +
The purpose of <span style="color:darkcyan;">''melog''</span> is to submit an entry to the '''Built-in''' [[Electronic Logbook (ELOG)]].  <span style="color:darkcyan;">''melog''</span> is used to submit the full Elog entry to the specified Elog port.
  
 +
To send an entry to an '''External''' [[Electronic Logbook (ELOG)]], use [[elog]] utility.
  
 
== Arguments ==
 
== Arguments ==
 
         [-h ] : help
 
         [-h ] : help
 
         [-h hostname ] : host name
 
         [-h hostname ] : host name
 +
        [-p port] : port on which [[mhttpd]] is running
 
         [-l exptname or logbook ]
 
         [-l exptname or logbook ]
 
         [-u username password ]
 
         [-u username password ]
Line 15: Line 23:
  
 
== Usage ==
 
== Usage ==
 +
melog -h <hostname> -p <port> -a author=myname "my message"
 +
 
By default the attributes are "Author", "Type", "System" and "Subject". The "Author" attribute has to be present in the elog command in order to successfully submit the message. If multiple attributes are required append before "text" field the full specification of the attribute. In case of multiple attachments, only one "-f" is required followed by up to 10 file names.
 
By default the attributes are "Author", "Type", "System" and "Subject". The "Author" attribute has to be present in the elog command in order to successfully submit the message. If multiple attributes are required append before "text" field the full specification of the attribute. In case of multiple attachments, only one "-f" is required followed by up to 10 file names.
  

Revision as of 16:33, 25 June 2015


Links

Purpose

The purpose of melog is to submit an entry to the Built-in Electronic Logbook (ELOG). melog is used to submit the full Elog entry to the specified Elog port.

To send an entry to an External Electronic Logbook (ELOG), use elog utility.

Arguments

       [-h ] : help
       [-h hostname ] : host name
       [-p port] : port on which mhttpd is running
       [-l exptname or logbook ]
       [-u username password ]
       [-f <attachment> ] : up to 10 files.
       -a <attribute>=<value> : up to 20 attributes.The attribute "Author=..." must be present for submission of Elog.
       -m <textfile> | text> Message. Arguments with blanks must be enclosed in quotes. The elog message can either be submitted  on the command line or in a file with the -m flag. Multiple attributes and attachments can be supplied.

Usage

melog -h <hostname> -p <port> -a author=myname "my message"

By default the attributes are "Author", "Type", "System" and "Subject". The "Author" attribute has to be present in the elog command in order to successfully submit the message. If multiple attributes are required append before "text" field the full specification of the attribute. In case of multiple attachments, only one "-f" is required followed by up to 10 file names.

Examples

    >melog -h myhost -p 8081 -l myexpt -a author=pierre "Just a elog message"
    >melog -h myhost -p 8081 -l myexpt -a author=pierre -f file2attach.txt \
                    "Just this message with an attachment"
    >melog -h myhost -p 8081 -l myexpt -a author=pierre -m file_containing_the_message.txt
    >melog -h myhost -p 8081 -l myexpt -a Author=pierre -a Type=routine -a system=general \
                    -a Subject="my test" "A full Elog message"