Merge branch 'master' of github.com:choll/xtr

choll · Apr 12, 2024 · 26bfcf4 · 26bfcf4
2 parents 6a00fd2 + 8ef6a19
commit 26bfcf4
Show file tree

Hide file tree

Showing 10 changed files with 27 additions and 27 deletions.
diff --git a/docs/api.html b/docs/api.html
diff --git a/docs/genindex.html b/docs/genindex.html
@@ -172,7 +172,7 @@ <h2 id="L">L</h2>
       <li><a href="api.html#_CPPv4N3xtr6loggerE">logger (C++ class)</a>
 
       <ul>
-        <li><a href="api.html#_CPPv4I0EN3xtr6logger6loggerE21storage_interface_ptrRR5ClockNSt6stringE17log_level_style_t">(C++ function)</a>, <a href="api.html#_CPPv4I0EN3xtr6logger6loggerENSt6stringEP4FILERR5ClockNSt6stringE17log_level_style_t">[1]</a>, <a href="api.html#_CPPv4I0EN3xtr6logger6loggerEP4FILERR5ClockNSt6stringE17log_level_style_t">[2]</a>, <a href="api.html#_CPPv4I0EN3xtr6logger6loggerEPKcRR5ClockNSt6stringE17log_level_style_t">[3]</a>
+        <li><a href="api.html#_CPPv4I0EN3xtr6logger6loggerE21storage_interface_ptrRR5ClockNSt6stringE17log_level_style_t12option_flags">(C++ function)</a>, <a href="api.html#_CPPv4I0EN3xtr6logger6loggerENSt6stringEP4FILERR5ClockNSt6stringE17log_level_style_t12option_flags">[1]</a>, <a href="api.html#_CPPv4I0EN3xtr6logger6loggerEP4FILERR5ClockNSt6stringE17log_level_style_t12option_flags">[2]</a>, <a href="api.html#_CPPv4I0EN3xtr6logger6loggerEPKcRR5ClockNSt6stringE17log_level_style_t12option_flags">[3]</a>
 </li>
       </ul></li>
   </ul></td>

diff --git a/docs/guide.html b/docs/guide.html
@@ -487,7 +487,7 @@ <h2>Formatting Containers, Tuples and Pairs<a class="headerlink" href="#formatti
 fast.</p>
 <p><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">std::chrono::system_clock()</span></code> is used to read the current time, this can
 be customised by passing an arbitrary function to the ‘clock’ parameter when
-constructing the logger (see <a class="reference internal" href="api.html#_CPPv4I0EN3xtr6logger6loggerEPKcRR5ClockNSt6stringE17log_level_style_t" title="xtr::logger::logger"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">xtr::logger::logger()</span></code></a>). In these macros</p>
+constructing the logger (see <a class="reference internal" href="api.html#_CPPv4I0EN3xtr6logger6loggerEPKcRR5ClockNSt6stringE17log_level_style_t12option_flags" title="xtr::logger::logger"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">xtr::logger::logger()</span></code></a>). In these macros</p>
 </section>
 <section id="real-time-clock">
 <h3>Real-time Clock<a class="headerlink" href="#real-time-clock" title="Link to this heading"></a></h3>

diff --git a/docs/libxtr-quickstart.3 b/docs/libxtr-quickstart.3
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "LIBXTR-QUICKSTART" "3" "December 2023" "" "xtr"
+.TH "LIBXTR-QUICKSTART" "3" "April 2024" "" "xtr"
 .SH NAME
 libxtr-quickstart \- C++ logging library quick-start guide
 .SH INSTALLING

diff --git a/docs/libxtr-userguide.3 b/docs/libxtr-userguide.3
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "LIBXTR-USERGUIDE" "3" "December 2023" "" "xtr"
+.TH "LIBXTR-USERGUIDE" "3" "April 2024" "" "xtr"
 .SH NAME
 libxtr-userguide \- C++ logging library user guide
 .SH OVERVIEW

diff --git a/docs/libxtr.3 b/docs/libxtr.3
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "LIBXTR" "3" "December 2023" "" "xtr"
+.TH "LIBXTR" "3" "April 2024" "" "xtr"
 .SH NAME
 libxtr \- C++ logging library API reference
 .SH LOG MACROS
@@ -252,7 +252,7 @@ The main logger class. When constructed a background thread will be created whic
 Public Functions
 .INDENT 7.0
 .TP
-.B template<typename Clock = std::chrono::system_clock> inline explicit logger(const char *path, \fI\%Clock\fP &&clock = \fI\%Clock\fP(), std::string command_path = \fI\%default_command_path\fP(), \fI\%log_level_style_t\fP level_style = \fI\%default_log_level_style\fP) 
+.B template<typename Clock = std::chrono::system_clock> inline explicit logger(const char *path, \fI\%Clock\fP &&clock = \fI\%Clock\fP(), std::string command_path = \fI\%default_command_path\fP(), \fI\%log_level_style_t\fP level_style = \fI\%default_log_level_style\fP, option_flags options = option_flags::none) 
 Path constructor. The first argument is the path to a file which should be opened and logged to. The file will be opened in append mode, and will be created if it does not exist. Errors will be written to stdout.
 .sp
 .INDENT 7.0
@@ -269,7 +269,7 @@ level_style: The log level style that will be used to prefix each log statement\
 .UNINDENT
 .INDENT 7.0
 .TP
-.B template<typename Clock = std::chrono::system_clock> inline explicit logger(FILE *stream = stderr, \fI\%Clock\fP &&clock = \fI\%Clock\fP(), std::string command_path = \fI\%default_command_path\fP(), \fI\%log_level_style_t\fP level_style = \fI\%default_log_level_style\fP) 
+.B template<typename Clock = std::chrono::system_clock> inline explicit logger(FILE *stream = stderr, \fI\%Clock\fP &&clock = \fI\%Clock\fP(), std::string command_path = \fI\%default_command_path\fP(), \fI\%log_level_style_t\fP level_style = \fI\%default_log_level_style\fP, option_flags options = option_flags::none) 
 Stream constructor.
 .sp
 It is expected that this constructor will be used with streams such as stdout or stderr. If a stream that has been opened by the user is to be passed to the logger then the \fI\%stream constructor with reopen path\fP constructor is recommended instead, as this will mean that the log file can be rotated\-\-\-please refer to the xtrctl documentation for the \fI\%reopening log files\fP command for details.
@@ -295,7 +295,7 @@ Reopening the log file via the \fI\%xtrctl\fP tool is \fInot\fP supported if thi
 .UNINDENT
 .INDENT 7.0
 .TP
-.B template<typename Clock = std::chrono::system_clock> inline logger(std::string reopen_path, FILE *stream, \fI\%Clock\fP &&clock = \fI\%Clock\fP(), std::string command_path = \fI\%default_command_path\fP(), \fI\%log_level_style_t\fP level_style = \fI\%default_log_level_style\fP) 
+.B template<typename Clock = std::chrono::system_clock> inline logger(std::string reopen_path, FILE *stream, \fI\%Clock\fP &&clock = \fI\%Clock\fP(), std::string command_path = \fI\%default_command_path\fP(), \fI\%log_level_style_t\fP level_style = \fI\%default_log_level_style\fP, option_flags options = option_flags::none) 
  Stream constructor with reopen path.
 .sp
 .INDENT 7.0
@@ -321,7 +321,7 @@ Reopening the log file via the \fI\%xtrctl\fP tool is supported, with the reopen
 .UNINDENT
 .INDENT 7.0
 .TP
-.B template<typename Clock = std::chrono::system_clock> inline explicit logger(\fI\%storage_interface_ptr\fP storage, \fI\%Clock\fP &&clock = \fI\%Clock\fP(), std::string command_path = \fI\%default_command_path\fP(), \fI\%log_level_style_t\fP level_style = \fI\%default_log_level_style\fP) 
+.B template<typename Clock = std::chrono::system_clock> inline explicit logger(\fI\%storage_interface_ptr\fP storage, \fI\%Clock\fP &&clock = \fI\%Clock\fP(), std::string command_path = \fI\%default_command_path\fP(), \fI\%log_level_style_t\fP level_style = \fI\%default_log_level_style\fP, option_flags options = option_flags::none) 
  Custom back\-end constructor (please refer to the \fI\%custom back\-ends\fP section of the user guide for further details on implementing a custom back\-end).
 .sp
 .INDENT 7.0

diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/xtrctl.1 b/docs/xtrctl.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "XTRCTL" "1" "December 2023" "" "xtr"
+.TH "XTRCTL" "1" "April 2024" "" "xtr"
 .SH NAME
 xtrctl \- Control tool for the xtr logger
 .SH SYNOPSIS

diff --git a/docs/xtrctl.html b/docs/xtrctl.html
@@ -171,7 +171,7 @@ <h3>Setting Log Levels<a class="headerlink" href="#setting-log-levels" title="Li
 <p>Please refer to the documentation for <a class="reference internal" href="api.html#_CPPv4N3xtr20default_command_pathEv" title="xtr::default_command_path"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">xtr::default_command_path()</span></code></a> in
 the API reference or <strong>libxtr</strong>(3) for an explanation of how the default
 socket path is constructed. Custom command paths may be specified either by
-passing an argument to <a class="reference internal" href="api.html#_CPPv4I0EN3xtr6logger6loggerEPKcRR5ClockNSt6stringE17log_level_style_t" title="xtr::logger::logger"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">xtr::logger::logger()</span></code></a> or by calling
+passing an argument to <a class="reference internal" href="api.html#_CPPv4I0EN3xtr6logger6loggerEPKcRR5ClockNSt6stringE17log_level_style_t12option_flags" title="xtr::logger::logger"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">xtr::logger::logger()</span></code></a> or by calling
 <a class="reference internal" href="api.html#_CPPv4N3xtr6logger16set_command_pathENSt6stringE" title="xtr::logger::set_command_path"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">xtr::logger::set_command_path()</span></code></a>, the documentation for both may also
 be found in the API reference or <strong>libxtr</strong>(3).</p>
 </section>