Core LibraryalphaAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-cxx latest

Server.check_file

Parse the same file and report what tmux would refuse in it, running none of it.

Source and package
Qualified name
libtmux::Server::check_file
Namespace
libtmux
Declared in
Server
Package
libtmux-cxx
Source
include/libtmux/server.hpp
[[C++ nodiscard attributeAsks the compiler to warn when a result is discarded. An explicit cast to void acknowledges that the result is intentionally ignored.Language documentation]] expected<void, CommandFailure> check_file(const std::filesystem::path& file) const;

Description#

This is how a program checks a configuration it is about to apply without applying half of it first.

Parameters

tmux command#

The tmux commands behind check_file.

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference