summaryrefslogtreecommitdiff
path: root/src/journal/catalog.h
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2012-11-15 23:03:31 +0100
committerLennart Poettering <lennart@poettering.net>2012-11-15 23:09:07 +0100
commitd4205751d4643c272059a3728045929dd0e5e800 (patch)
treec9931806e99d42789fc5ce3fc03e17285b9bb208 /src/journal/catalog.h
parent59f432ea6d6d441d0af7c76c37e80730c8df473a (diff)
journal: implement message catalog
The message catalog can be used to attach short help texts to log lines, keyed by their MESSAGE_ID= fields. This is useful to help the administrator understand the context and cause of a message, find possible solutions and find further related documentation. Since this is keyed off MESSAGE_ID= this will only work for native journal messages. The message catalog supports i18n, and is useful to augment english language system messages with explanations in the local language. This commit only includes short explanatory messages for a few example message IDs, we'll add more complete documentation for the relevant systemd messages later on.
Diffstat (limited to 'src/journal/catalog.h')
-rw-r--r--src/journal/catalog.h28
1 files changed, 28 insertions, 0 deletions
diff --git a/src/journal/catalog.h b/src/journal/catalog.h
new file mode 100644
index 000000000..9add773c9
--- /dev/null
+++ b/src/journal/catalog.h
@@ -0,0 +1,28 @@
+/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
+
+#pragma once
+
+/***
+ This file is part of systemd.
+
+ Copyright 2012 Lennart Poettering
+
+ systemd is free software; you can redistribute it and/or modify it
+ under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation; either version 2.1 of the License, or
+ (at your option) any later version.
+
+ systemd is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with systemd; If not, see <http://www.gnu.org/licenses/>.
+***/
+
+#include "sd-id128.h"
+
+int catalog_update(void);
+int catalog_get(sd_id128_t id, char **data);
+int catalog_list(FILE *f);