Skip to content

Latest commit

 

History

History
108 lines (81 loc) · 3.81 KB

README.md

File metadata and controls

108 lines (81 loc) · 3.81 KB

rust-systemd

crate docs (systemd)

crate docs (libsystemd-sys)

systemdCrates.io

libsystemd-sysCrates.io

In Cargo.toml:

[dependencies]
systemd = "0.10"

Build Environment variables

By default, libsystemd-sys will use pkg-config to find libsystemd. It defaults to using the libsystemd package. To change the package looked up in pkg-config, set the SYSTEMD_PKG_NAME environment variable.

If you want to override the source of the libsystemd directly, set the env var SYSTEMD_LIB_DIR to a path which contains the libsystemd to link against. Optionally, you may also set SYSTEMD_LIBS to indicate which libraries to link against. Libraries in the variable SYSTEMD_LIBS are colon (:) separated and may include a KIND. For example: SYSTEMD_LIBS="static=foo:bar".

elogind support

Either set SYSTEMD_PKG_NAME=libelogind (name of the pkg-config file) or set both SYSTEMD_LIBS=elogind and set SYSTEMD_LIB_DIR to the appropriate directory.

When using elogind, the apis needed for journal and bus features may not be completely available (elogind forked from an older version of systemd that may lack some of these APIs). If your application does not need these features, depend on systemd without the default features to allow maximum compatibility:

[dependencies]
systemd = { version = "0.10", default-features = false }

Note that there still may be some missing symbols. If you discover a link error, report it so that we can tweak the systemd crate to support it.

journal

Journal sending is supported, and systemd::journal::Journal is a (low functionality) wrapper around the read API.

An example of the journal writing api:

use log::warn;
use systemd::{journal, sd_journal_log};

fn main() {
   journal::print(1, &format!("Rust can talk to the journal: {:?}", 4));
   journal::send(&["CODE_FILE=HI", "CODE_LINE=1213", "CODE_FUNCTION=LIES"]);
   journal::JournalLog::init().unwrap();
   warn!("HI");
   sd_journal_log!(4, "HI {:?}", 2);
}

daemon

The daemon API mostly offers tools for working with raw filehandles passed to the process by systemd on socket activation. Since raw filehandles are not well supported in Rust, it's likely these functions will mostly be helpful in managing program flow; actual socket code will have to use the libc crate.

License

This library 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.

In addition to the permissions in the GNU Lesser General Public License, the authors give you unlimited permission to link the compiled version of this library into combinations with other programs, and to distribute those programs without any restriction coming from the use of this library. (The Lesser General Public License restrictions do apply in other respects; for example, they cover modification of the library, and distribution when not linked into another program.)

This library 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.

Contributions

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be licensed as above, without any additional terms or conditions.