はじめに たまに使うので、 bridge コマンドをメモ。 bridge コマンド チートシート (iproute2 6.1.0) 概要 bridge コマンドは、Linux のブリッジデバイスの管理を行うためのツールである。 ネットワークブリッジの追加、削除、設定変更、監視などが可能。 使用例 ブリッジデバイスの管理 コマンド 説明 bridge add dev br0 新しいブリッジデバイス br0 を作成 bridge del dev br0 ブリッジ br0 を削除 bridge link show ブリッジに接続されているリンクを表示 bridge set dev br0 stp_state 1 br0 のSTP (スパニングツリープロトコル) を有効化 bridge set dev br0 stp_state 0 br0 のSTP を無効化 ポートの管理 コマンド 説明 bridge link set dev eth0 master br0 eth0 を br0 に追加 bridge link set dev eth0 nomaster eth0 をブリッジから削除 bridge vlan add dev eth0 vid 10 eth0 に VLAN 10 を追加 bridge vlan del dev eth0 vid 10 eth0 から VLAN 10 を削除 VLAN の管理 コマンド 説明 bridge vlan show VLAN 設定の一覧表示 bridge vlan add dev eth0 vid 100 pvid untagged eth0 に VLAN 100 を PVID として追加 bridge vlan del dev eth0 vid 100 eth0 から VLAN 100 を削除 FDB (Forwarding Database) の管理 コマンド 説明 bridge fdb show MAC アドレスのフォワーディングデータベースを表示 bridge fdb add 00:11:22:33:44:55 dev eth0 master br0 MAC アドレスを br0 の fdb に追加 bridge fdb del 00:11:22:33:44:55 dev eth0 master br0 MAC アドレスを br0 の fdb から削除 MDB (Multicast Database) の管理 コマンド 説明 bridge mdb show マルチキャストデータベースを表示 bridge mdb add dev br0 port eth0 grp 239.0.0.1 permanent br0 にマルチキャストグループを追加 bridge mdb del dev br0 port eth0 grp 239.0.0.1 br0 からマルチキャストグループを削除 モニタリング コマンド 説明 bridge monitor ブリッジ関連のイベントをリアルタイムで監視 bridge -n monitor ネットワークネームスペースを含めて監視 まとめ bridge コマンドは Linux ネットワークブリッジを詳細に管理するためのツールであり、STP、VLAN、FDB、MDB の操作をサポートしている。 特に VLAN や FDB の設定を動的に管理する際に有用である。 ...

はじめに IPv6について、すぐ忘れるので学習したことを自分用にまとめる。 用語 個人的にL2,L3ヘッダについて触れるときは、送信元、送信先の意味で、ツールでよく表現される通り、ソース(Source), デスティネーション(Destination)という表現を使うことがあります。 基本 IPv6の誕生経緯 IPv4のアドレスが枯渇するので、対策として作られた。 ARPではなく後述するNDPが使われたりと、単にアドレスの種類が増えただけではなく、運用方法も大きく変化している。 IPv4との互換性 IPv6とIPv4プロトコルの間には互換性はない(IPv6対応のサーバとIPv6対応のクライアントでのみ通信できる)。 なので、サーバがIPv6対応していないとIPv6のPC(クライアントの意味)からアクセスできないし、サーバがIPv6対応していてもPCがIPv6対応していないとIPv6での通信はできない。 また、通信経路のルーターも全てIPv6対応していないといけない(つまり、ISPが対応してないといけない)。 アドレス比較 比較表 IPv4 IPv6 MAC アドレスデータサイズ 4バイト 16バイト 6バイト 理論アドレス数 約43億 約340澗(1澗は1兆×1兆×1兆) 約281兆 アドレス例 127.0.0.0/32(DECIMAL、10進数) 1102:5::1BF5:80:F71F:A2/128(HEX、16進数) 14:A3:B0:24:89:1C(HEX、16進数) アドレスの種類 ユニキャストアドレス ユニキャストアドレス マルチキャストアドレス マルチキャストアドレス ブロードキャストアドレス (廃止) アドレスの表記 基本は、2byte:2byte:2byte:2byte:2byte:2byte:2byte:2byte(HEX) で表す(IPv4のときはDECIMAL表記が一般的だが、IPv6はHEX表記)。 大文字小文字は区別されない。 また、IPv4のときと同様に、サブネットは/<ビット>(例: /64)のように表す。 ここで2byte部分はデータ列というより数値と考えて良いみたい。つまり、0でHEX表記4文字にパディングしなくても勝手に先頭は0埋めしてくれる。自分で0埋めしてもよい。 また、上記の2byteの単位において、2byte=0が連続しているとき、連続している:0:を::で置き換えて良い。 表記種類 アドレス例 最短(つまり、通常)表記 1102:5::1BF5:80:F71F:A2 中間表記(の1つ) 1102:0005:0:0:1BF5:0080:F71F:00A2 最長表記 1102:0005:0000:0000:1BF5:0080:F71F:00A2 オンラインコンバーター: https://dnschecker.org/ipv6-expand.php アドレスの種類 大きく分けて、下記の3つがある。 ユニキャストアドレス マルチキャストアドレス 順に見ていく。 1.ユニキャストアドレス IPv4でも同じだが、利用して送付する際に最終的な宛先となるマシンが1つのアドレス。 大きく分けて、次の4つがある。順に見ていく。 項目名 ユニキャストアドレス名 1-1 グローバルユニキャストアドレス 1-2 ユニークローカルアドレス 1-3 リンクローカルアドレス 1-4 ループバックアドレス 1-1. グローバルユニキャストアドレス インターネット上で一意に割り当てられるアドレス。 そこまで既存の挙動と大きく変わらない。 ...

はじめに 個人的にはまだgrepの方がよく使うが、rgも使いこなせるようになっていきたいのでメモ。 ripgrep (rg) コマンド チートシート 概要 ripgrep (rg) は、Rust製の高速なファイル検索を可能にするコマンドラインツール。 grepの代替として、ツールの依存などで特に高速化目的で要求されがち。 ex: Astronvim Requirements 基本的な使い方 現在のディレクトリ内で文字列を検索する。 rg "pattern" 特定のファイル内で検索する。 rg "pattern" file.txt 特定のディレクトリを指定して検索する。 rg "pattern" path/to/directory/ 正規表現を使用した検索 正規表現を使用して検索する。 rg "^pattern" 大文字小文字を区別しない検索を行う。 rg -i "pattern" ファイルタイプの指定 特定のファイル拡張子に限定して検索する。 rg "pattern" -g "*.txt" 特定のプログラミング言語のファイル内を検索する。 rg "pattern" --type rust 特定のファイルを除外する。 rg "pattern" --ignore-file .gitignore 出力オプション 行番号を表示する。 rg -n "pattern" 一致した部分のみを表示する。 rg -o "pattern" 一致しない行を表示する (逆マッチ)。 rg -v "pattern" コンテキストの表示 前後の行も含めて表示する。 rg -C 3 "pattern" 前の行を表示する。 rg -B 3 "pattern" 後の行を表示する。 rg -A 3 "pattern" バイナリファイルの検索 バイナリファイルを検索対象に含める。 rg --text "pattern" バイナリファイルを無視する。 rg --no-text "pattern" よく使うオプション 説明 オプション 再帰的に検索 (デフォルト) 大文字小文字を無視 -i 行番号を表示 -n 一致部分のみ表示 -o 一致しない行を表示 -v ファイル拡張子を指定 -g "*.ext" 言語を指定 --type <language> 前後の行を表示 -C <num> 前の行を表示 -B <num> 後の行を表示 -A <num> バイナリファイルを検索対象に含める --text バイナリファイルを無視する --no-text 参考リンク ripgrep ドキュメント man rgより引用 RG(1) User Commands RG(1) NAME rg - recursively search the current directory for lines matching a pattern SYNOPSIS rg [OPTIONS] PATTERN [PATH...] rg [OPTIONS] -e PATTERN... [PATH...] rg [OPTIONS] -f PATTERNFILE... [PATH...] rg [OPTIONS] --files [PATH...] rg [OPTIONS] --type-list command | rg [OPTIONS] PATTERN rg [OPTIONS] --help rg [OPTIONS] --version DESCRIPTION ripgrep (rg) recursively searches the current directory for a regex pattern. By default, ripgrep will respect your .gitignore and automat‐ ically skip hidden files/directories and binary files. ripgrep's default regex engine uses finite automata and guarantees linear time searching. Because of this, features like backreferences and arbitrary look-around are not supported. However, if ripgrep is built with PCRE2, then the -P/--pcre2 flag can be used to enable backrefer‐ ences and look-around. ripgrep supports configuration files. Set RIPGREP_CONFIG_PATH to a configuration file. The file can specify one shell argument per line. Lines starting with # are ignored. For more details, see CONFIGURATION FILES below. ripgrep will automatically detect if stdin exists and search stdin for a regex pattern, e.g. ls | rg foo. In some environments, stdin may exist when it shouldn't. To turn off stdin detection, one can explicitly specify the directory to search, e.g. rg foo ./. Like other tools such as ls, ripgrep will alter its output depending on whether stdout is connected to a tty. By default, when printing a tty, ripgrep will enable colors, line numbers and a heading format that lists each matching file path once instead of once per matching line. Tip: to disable all smart filtering and make ripgrep behave a bit more like classical grep, use rg -uuu. REGEX SYNTAX ripgrep uses Rust's regex engine by default, which documents its syntax: https://docs.rs/regex/1.*/regex/#syntax ripgrep uses byte-oriented regexes, which has some additional documentation: https://docs.rs/regex/1.*/regex/bytes/index.html#syntax To a first approximation, ripgrep uses Perl-like regexes without look-around or backreferences. This makes them very similar to the "ex‐ tended" (ERE) regular expressions supported by *egrep*, but with a few additional features like Unicode character classes. If you're using ripgrep with the -P/--pcre2 flag, then please consult https://www.pcre.org or the PCRE2 man pages for documentation on the supported syntax. POSITIONAL ARGUMENTS PATTERN A regular expression used for searching. To match a pattern beginning with a dash, use the -e/--regexp option. PATH A file or directory to search. Directories are searched recursively. File paths specified explicitly on the command line over‐ ride glob and ignore rules. OPTIONS This section documents all flags that ripgrep accepts. Flags are grouped into categories below according to their function. Note that many options can be turned on and off. In some cases, those flags are not listed explicitly below. For example, the --column flag (listed below) enables column numbers in ripgrep's output, but the --no-column flag (not listed below) disables them. The reverse can also exist. For example, the --no-ignore flag (listed below) disables ripgrep's gitignore logic, but the --ignore flag (not listed below) en‐ ables it. These flags are useful for overriding a ripgrep configuration file (or alias) on the command line. Each flag's documentation notes whether an inverted flag exists. In all cases, the flag specified last takes precedence. INPUT OPTIONS -e PATTERN, --regexp=PATTERN A pattern to search for. This option can be provided multiple times, where all patterns given are searched, in addition to any patterns provided by -f/--file. Lines matching at least one of the provided patterns are printed. This flag can also be used when searching for patterns that start with a dash. For example, to search for the literal -foo: rg -e -foo You can also use the special -- delimiter to indicate that no more flags will be provided. Namely, the following is equivalent to the above: rg -- -foo When -f/--file or -e/--regexp is used, then ripgrep treats all positional arguments as files or directories to search. -f PATTERNFILE, --file=PATTERNFILE Search for patterns from the given file, with one pattern per line. When this flag is used multiple times or in combination with the -e/--regexp flag, then all patterns provided are searched. Empty pattern lines will match all input lines, and the newline is not counted as part of the pattern. A line is printed if and only if it matches at least one of the patterns. When PATTERNFILE is -, then stdin will be read for the patterns. When -f/--file or -e/--regexp is used, then ripgrep treats all positional arguments as files or directories to search. --pre=COMMAND For each input PATH, this flag causes ripgrep to search the standard output of COMMAND PATH instead of the contents of PATH. This op‐ tion expects the COMMAND program to either be a path or to be available in your PATH. Either an empty string COMMAND or the --no-pre flag will disable this behavior. WARNING When this flag is set, ripgrep will unconditionally spawn a process for every file that is searched. Therefore, this can incur an unnecessarily large performance penalty if you don't otherwise need the flexibility offered by this flag. One pos‐ sible mitigation to this is to use the --pre-glob flag to limit which files a preprocessor is run with. A preprocessor is not run when ripgrep is searching stdin. When searching over sets of files that may require one of several preprocessors, COMMAND should be a wrapper program which first clas‐ sifies PATH based on magic numbers/content or based on the PATH name and then dispatches to an appropriate preprocessor. Each COMMAND also has its standard input connected to PATH for convenience. For example, a shell script for COMMAND might look like: case "$1" in *.pdf) exec pdftotext "$1" - ;; *) case $(file "$1") in *Zstandard*) exec pzstd -cdq ;; *) exec cat ;; esac ;; esac The above script uses pdftotext to convert a PDF file to plain text. For all other files, the script uses the file utility to sniff the type of the file based on its contents. If it is a compressed file in the Zstandard format, then pzstd is used to decompress the con‐ tents to stdout. This overrides the -z/--search-zip flag. --pre-glob=GLOB This flag works in conjunction with the --pre flag. Namely, when one or more --pre-glob flags are given, then only files that match the given set of globs will be handed to the command specified by the --pre flag. Any non-matching files will be searched without using the preprocessor command. This flag is useful when searching many files with the --pre flag. Namely, it provides the ability to avoid process overhead for files that don't need preprocessing. For example, given the following shell script, pre-pdftotext: #!/bin/sh pdftotext "$1" - then it is possible to use --pre pre-pdftotext --pre-glob pre-pdftotext command on files with a .pdf extension. Multiple --pre-glob flags may be used. Globbing rules match gitignore globs. Precede a glob with a ! to exclude it. This flag has no effect if the --pre flag is not used. -z, --search-zip This flag instructs ripgrep to search in compressed files. Currently gzip, bzip2, xz, LZ4, LZMA, Brotli and Zstd files are supported. This option expects the decompression binaries (such as gzip) to be available in your PATH. If the required binaries are not found, then ripgrep will not emit an error messages by default. Use the --debug flag to see more information. Note that this flag does not make ripgrep search archive formats as directory trees. It only makes ripgrep detect compressed files and then decompress them before searching their contents as it would any other file. This overrides the --pre flag. This flag can be disabled with --no-search-zip. SEARCH OPTIONS -s, --case-sensitive Execute the search case sensitively. This is the default mode. This is a global option that applies to all patterns given to ripgrep. Individual patterns can still be matched case insensitively by using inline regex flags. For example, (?i)abc will match abc case insensitively even when this flag is used. This flag overrides the -i/--ignore-case and -S/--smart-case flags. --crlf When enabled, ripgrep will treat CRLF (\r\n) as a line terminator instead of just \n. Principally, this permits the line anchor assertions ^ and $ in regex patterns to treat CRLF, CR or LF as line terminators instead of just LF. Note that they will never match between a CR and a LF. CRLF is treated as one single line terminator. When using the default regex engine, CRLF support can also be enabled inside the pattern with the R flag. For example, (?R:$) will match just before either CR or LF, but never between CR and LF. This flag overrides --null-data. This flag can be disabled with --no-crlf. --dfa-size-limit=NUM+SUFFIX? The upper size limit of the regex DFA. The default limit is something generous for any single pattern or for many smallish patterns. This should only be changed on very large regex inputs where the (slower) fallback regex engine may otherwise be used if the limit is reached. The input format accepts suffixes of K, M or G which correspond to kilobytes, megabytes and gigabytes, respectively. If no suffix is provided the input is treated as bytes. -E ENCODING, --encoding=ENCODING Specify the text encoding that ripgrep will use on all files searched. The default value is auto, which will cause ripgrep to do a best effort automatic detection of encoding on a per-file basis. Automatic detection in this case only applies to files that begin with a UTF-8 or UTF-16 byte-order mark (BOM). No other automatic detection is performed. One can also specify none which will then completely disable BOM sniffing and always result in searching the raw bytes, including a BOM if it's present, regardless of its encoding. Other supported values can be found in the list of labels here: https://encoding.spec.whatwg.org/#concept-encoding-get. For more details on encoding and how ripgrep deals with it, see GUIDE.md. The encoding detection that ripgrep uses can be reverted to its automatic mode via the --no-encoding flag. --engine=ENGINE Specify which regular expression engine to use. When you choose a regex engine, it applies that choice for every regex provided to rip‐ grep (e.g., via multiple -e/--regexp or -f/--file flags). Accepted values are default, pcre2, or auto. The default value is default, which is usually the fastest and should be good for most use cases. The pcre2 engine is generally useful when you want to use features such as look-around or backreferences. auto will dynamically choose between supported regex engines de‐ pending on the features used in a pattern on a best effort basis. Note that the pcre2 engine is an optional ripgrep feature. If PCRE2 wasn't included in your build of ripgrep, then using this flag will result in ripgrep printing an error message and exiting. This overrides previous uses of the -P/--pcre2 and --auto-hybrid-regex flags. -F, --fixed-strings Treat all patterns as literals instead of as regular expressions. When this flag is used, special regular expression meta characters such as .(){}*+ should not need be escaped. This flag can be disabled with --no-fixed-strings. -i, --ignore-case When this flag is provided, all patterns will be searched case insensitively. The case insensitivity rules used by ripgrep's default regex engine conform to Unicode's "simple" case folding rules. This is a global option that applies to all patterns given to ripgrep. Individual patterns can still be matched case sensitively by using inline regex flags. For example, (?-i)abc will match abc case sensitively even when this flag is used. This flag overrides -s/--case-sensitive and -S/--smart-case. -v, --invert-match This flag inverts matching. That is, instead of printing lines that match, ripgrep will print lines that don't match. Note that this only inverts line-by-line matching. For example, combining this flag with -l/--files-with-matches will emit files that contain any lines that do not match the patterns given. That's not the same as, for example, --files-without-match, which will emit files that do not contain any matching lines. This flag can be disabled with --no-invert-match. -x, --line-regexp When enabled, ripgrep will only show matches surrounded by line boundaries. This is equivalent to surrounding every pattern with ^ and $. In other words, this only prints lines where the entire line participates in a match. This overrides the -w/--word-regexp flag. -m NUM, --max-count=NUM Limit the number of matching lines per file searched to NUM. Note that 0 is a legal value but not likely to be useful. When used, ripgrep won't search anything. --mmap When enabled, ripgrep will search using memory maps when possible. This is enabled by default when ripgrep thinks it will be faster. Memory map searching cannot be used in all circumstances. For example, when searching virtual files or streams likes stdin. In such cases, memory maps will not be used even when this flag is enabled. Note that ripgrep may abort unexpectedly when memory maps are used if it searches a file that is simultaneously truncated. Users can opt out of this possibility by disabling memory maps. This flag can be disabled with --no-mmap. -U, --multiline This flag enable searching across multiple lines. When multiline mode is enabled, ripgrep will lift the restriction that a match cannot include a line terminator. For example, when mul‐ tiline mode is not enabled (the default), then the regex \p{any} will match any Unicode codepoint other than \n. Similarly, the regex \n is explicitly forbidden, and if you try to use it, ripgrep will return an error. However, when multiline mode is enabled, \p{any} will match any Unicode codepoint, including \n, and regexes like \n are permitted. An important caveat is that multiline mode does not change the match semantics of .. Namely, in most regex matchers, a . will by de‐ fault match any character other than \n, and this is true in ripgrep as well. In order to make . match \n, you must enable the "dot all" flag inside the regex. For example, both (?s). and (?s:.) have the same semantics, where . will match any character, including \n. Alternatively, the --multiline-dotall flag may be passed to make the "dot all" behavior the default. This flag only applies when multi‐ line search is enabled. There is no limit on the number of the lines that a single match can span. WARNING: Because of how the underlying regex engine works, multiline searches may be slower than normal line-oriented searches, and they may also use more memory. In particular, when multiline mode is enabled, ripgrep requires that each file it searches is laid out contiguously in memory (either by reading it onto the heap or by memory-mapping it). Things that cannot be memory-mapped (such as stdin) will be consumed until EOF before searching can begin. In general, ripgrep will only do these things when necessary. Specifi‐ cally, if the -U/--multiline flag is provided but the regex does not contain patterns that would match \n characters, then ripgrep will automatically avoid reading each file into memory before searching it. Nevertheless, if you only care about matches spanning at most one line, then it is always better to disable multiline mode. This overrides the --stop-on-nonmatch flag. This flag can be disabled with --no-multiline. --multiline-dotall This flag enables "dot all" mode in all regex patterns. This causes . to match line terminators when multiline searching is enabled. This flag has no effect if multiline searching isn't enabled with the -U/--multiline flag. Normally, a . will match any character except line terminators. While this behavior typically isn't relevant for line-oriented matching (since matches can span at most one line), this can be useful when searching with the -U/--multiline flag. By default, multiline mode runs without "dot all" mode enabled. This flag is generally intended to be used in an alias or your ripgrep config file if you prefer "dot all" semantics by default. Note that regardless of whether this flag is used, "dot all" semantics can still be controlled via inline flags in the regex pattern itself, e.g., (?s:.) always enables "dot all" whereas (?-s:.) always disables "dot all". Moreover, you can use character classes like \p{any} to match any Unicode codepoint regardless of whether "dot all" mode is enabled or not. This flag can be disabled with --no-multiline-dotall. --no-unicode This flag disables Unicode mode for all patterns given to ripgrep. By default, ripgrep will enable "Unicode mode" in all of its regexes. This has a number of consequences: • . will only match valid UTF-8 encoded Unicode scalar values. • Classes like \w, \s, \d are all Unicode aware and much bigger than their ASCII only versions. • Case insensitive matching will use Unicode case folding. • A large array of classes like \p{Emoji} are available. (Although the specific set of classes available varies based on the regex en‐ gine. In general, the default regex engine has more classes available to it.) • Word boundaries (\b and \B) use the Unicode definition of a word character. In some cases it can be desirable to turn these things off. This flag will do exactly that. For example, Unicode mode can sometimes have a negative impact on performance, especially when things like \w are used frequently (including via bounded repetitions like \w{100}) when only their ASCII interpretation is needed. This flag can be disabled with --unicode. --null-data Enabling this flag causes ripgrep to use NUL as a line terminator instead of the default of \n. This is useful when searching large binary files that would otherwise have very long lines if \n were used as the line terminator. In particular, ripgrep requires that, at a minimum, each line must fit into memory. Using NUL instead can be a useful stopgap to keep mem‐ ory requirements low and avoid OOM (out of memory) conditions. This is also useful for processing NUL delimited data, such as that emitted when using ripgrep's -0/--null flag or find's --print0 flag. Using this flag implies -a/--text. It also overrides --crlf. -P, --pcre2 When this flag is present, ripgrep will use the PCRE2 regex engine instead of its default regex engine. This is generally useful when you want to use features such as look-around or backreferences. Using this flag is the same as passing --engine=pcre2. Users may instead elect to use --engine=auto to ask ripgrep to automatically se‐ lect the right regex engine based on the patterns given. This flag and the --engine flag override one another. Note that PCRE2 is an optional ripgrep feature. If PCRE2 wasn't included in your build of ripgrep, then using this flag will result in ripgrep printing an error message and exiting. PCRE2 may also have worse user experience in some cases, since it has fewer introspec‐ tion APIs than ripgrep's default regex engine. For example, if you use a \n in a PCRE2 regex without the -U/--multiline flag, then rip‐ grep will silently fail to match anything instead of reporting an error immediately (like it does with the default regex engine). This flag can be disabled with --no-pcre2. --regex-size-limit=NUM+SUFFIX? The size limit of the compiled regex, where the compiled regex generally corresponds to a single object in memory that can match all of the patterns provided to ripgrep. The default limit is generous enough that most reasonable patterns (or even a small number of them) should fit. This useful to change when you explicitly want to let ripgrep spend potentially much more time and/or memory building a regex matcher. The input format accepts suffixes of K, M or G which correspond to kilobytes, megabytes and gigabytes, respectively. If no suffix is provided the input is treated as bytes. -S, --smart-case This flag instructs ripgrep to searches case insensitively if the pattern is all lowercase. Otherwise, ripgrep will search case sensi‐ tively. A pattern is considered all lowercase if both of the following rules hold: • First, the pattern contains at least one literal character. For example, a\w contains a literal (a) but just \w does not. • Second, of the literals in the pattern, none of them are considered to be uppercase according to Unicode. For example, foo\pL has no uppercase literals but Foo\pL does. This overrides the -s/--case-sensitive and -i/--ignore-case flags. --stop-on-nonmatch Enabling this option will cause ripgrep to stop reading a file once it encounters a non-matching line after it has encountered a match‐ ing line. This is useful if it is expected that all matches in a given file will be on sequential lines, for example due to the lines being sorted. This overrides the -U/--multiline flag. -a, --text This flag instructs ripgrep to search binary files as if they were text. When this flag is present, ripgrep's binary file detection is disabled. This means that when a binary file is searched, its contents may be printed if there is a match. This may cause escape codes to be printed that alter the behavior of your terminal. When binary file detection is enabled, it is imperfect. In general, it uses a simple heuristic. If a NUL byte is seen during search, then the file is considered binary and searching stops (unless this flag is present). Alternatively, if the --binary flag is used, then ripgrep will only quit when it sees a NUL byte after it sees a match (or searches the entire file). This flag overrides the --binary flag. This flag can be disabled with --no-text. -j NUM, --threads=NUM This flag sets the approximate number of threads to use. A value of 0 (which is the default) causes ripgrep to choose the thread count using heuristics. -w, --word-regexp When enabled, ripgrep will only show matches surrounded by word boundaries. This is equivalent to surrounding every pattern with \b{start-half} and \b{end-half}. This overrides the -x/--line-regexp flag. --auto-hybrid-regex DEPRECATED. Use --engine instead. When this flag is used, ripgrep will dynamically choose between supported regex engines depending on the features used in a pattern. When ripgrep chooses a regex engine, it applies that choice for every regex provided to ripgrep (e.g., via multiple -e/--regexp or -f/--file flags). As an example of how this flag might behave, ripgrep will attempt to use its default finite automata based regex engine whenever the pattern can be successfully compiled with that regex engine. If PCRE2 is enabled and if the pattern given could not be compiled with the default regex engine, then PCRE2 will be automatically used for searching. If PCRE2 isn't available, then this flag has no effect because there is only one regex engine to choose from. In the future, ripgrep may adjust its heuristics for how it decides which regex engine to use. In general, the heuristics will be lim‐ ited to a static analysis of the patterns, and not to any specific runtime behavior observed while searching files. The primary downside of using this flag is that it may not always be obvious which regex engine ripgrep uses, and thus, the match se‐ mantics or performance profile of ripgrep may subtly and unexpectedly change. However, in many cases, all regex engines will agree on what constitutes a match and it can be nice to transparently support more advanced regex features like look-around and backreferences without explicitly needing to enable them. This flag can be disabled with --no-auto-hybrid-regex. --no-pcre2-unicode DEPRECATED. Use --no-unicode instead. Note that Unicode mode is enabled by default. This flag can be disabled with --pcre2-unicode. FILTER OPTIONS --binary Enabling this flag will cause ripgrep to search binary files. By default, ripgrep attempts to automatically skip binary files in order to improve the relevance of results and make the search faster. Binary files are heuristically detected based on whether they contain a NUL byte or not. By default (without this flag set), once a NUL byte is seen, ripgrep will stop searching the file. Usually, NUL bytes occur in the beginning of most binary files. If a NUL byte oc‐ curs after a match, then ripgrep will not print the match, stop searching that file, and emit a warning that some matches are being suppressed. In contrast, when this flag is provided, ripgrep will continue searching a file even if a NUL byte is found. In particular, if a NUL byte is found then ripgrep will continue searching until either a match is found or the end of the file is reached, whichever comes sooner. If a match is found, then ripgrep will stop and print a warning saying that the search stopped prematurely. If you want ripgrep to search a file without any special NUL byte handling at all (and potentially print binary data to stdout), then you should use the -a/--text flag. The --binary flag is a flag for controlling ripgrep's automatic filtering mechanism. As such, it does not need to be used when search‐ ing a file explicitly or when searching stdin. That is, it is only applicable when recursively searching a directory. When the -u/--unrestricted flag is provided for a third time, then this flag is automatically enabled. This flag overrides the -a/--text flag. This flag can be disabled with --no-binary. -L, --follow This flag instructs ripgrep to follow symbolic links while traversing directories. This behavior is disabled by default. Note that rip‐ grep will check for symbolic link loops and report errors if it finds one. ripgrep will also report errors for broken links. To sup‐ press error messages, use the --no-messages flag. This flag can be disabled with --no-follow. -g GLOB, --glob=GLOB Include or exclude files and directories for searching that match the given glob. This always overrides any other ignore logic. Multi‐ ple glob flags may be used. Globbing rules match .gitignore globs. Precede a glob with a ! to exclude it. If multiple globs match a file or directory, the glob given later in the command line takes precedence. As an extension, globs support specifying alternatives: -g 'ab{c,d}*' is equivalent to -g abc -g abd. Empty alternatives like -g 'ab{,c}' are not currently supported. Note that this syntax extension is also currently enabled in gitignore files, even though this syntax isn't supported by git itself. ripgrep may disable this syntax extension in gitignore files, but it will always remain available via the -g/--glob flag. When this flag is set, every file and directory is applied to it to test for a match. For example, if you only want to search in a par‐ ticular directory foo, then -g foo is incorrect because foo/bar does not match the glob foo. Instead, you should use -g 'foo/**'. --glob-case-insensitive Process all glob patterns given with the -g/--glob flag case insensitively. This effectively treats -g/--glob as --iglob. This flag can be disabled with --no-glob-case-insensitive. -., --hidden Search hidden files and directories. By default, hidden files and directories are skipped. Note that if a hidden file or a directory is whitelisted in an ignore file, then it will be searched even if this flag isn't provided. Similarly if a hidden file or directory is given explicitly as an argumnet to ripgrep. A file or directory is considered hidden if its base name starts with a dot character (.). On operating systems which support a "hid‐ den" file attribute, like Windows, files with this attribute are also considered hidden. This flag can be disabled with --no-hidden. --iglob=GLOB Include or exclude files and directories for searching that match the given glob. This always overrides any other ignore logic. Multi‐ ple glob flags may be used. Globbing rules match .gitignore globs. Precede a glob with a ! to exclude it. If multiple globs match a file or directory, the glob given later in the command line takes precedence. Globs used via this flag are matched case insensitively. --ignore-file=PATH Specifies a path to one or more gitignore formatted rules files. These patterns are applied after the patterns found in .gitignore, .rgignore and .ignore are applied and are matched relative to the current working directory. Multiple additional ignore files can be specified by using this flag repeatedly. When specifying multiple ignore files, earlier files have lower precedence than later files. If you are looking for a way to include or exclude files and directories directly on the command line, then use -g/--glob instead. --ignore-file-case-insensitive Process ignore files (.gitignore, .ignore, etc.) case insensitively. Note that this comes with a performance penalty and is most useful on case insensitive file systems (such as Windows). This flag can be disabled with --no-ignore-file-case-insensitive. -d NUM, --max-depth=NUM This flag limits the depth of directory traversal to NUM levels beyond the paths given. A value of 0 only searches the explicitly given paths themselves. For example, rg --max-depth 0 dir/ is a no-op because dir/ will not be descended into. rg --max-depth 1 dir/ will search only the di‐ rect children of dir. An alternative spelling for this flag is --maxdepth. --max-filesize=NUM+SUFFIX? Ignore files larger than NUM in size. This does not apply to directories. The input format accepts suffixes of K, M or G which correspond to kilobytes, megabytes and gigabytes, respectively. If no suffix is provided the input is treated as bytes. Examples: --max-filesize 50K or --max-filesize 80M. --no-ignore When set, ignore files such as .gitignore, .ignore and .rgignore will not be respected. This implies --no-ignore-dot, --no-ignore-ex‐ clude, --no-ignore-global, --no-ignore-parent and --no-ignore-vcs. This does not imply --no-ignore-files, since --ignore-file is specified explicitly as a command line argument. When given only once, the -u/--unrestricted flag is identical in behavior to this flag and can be considered an alias. However, subse‐ quent -u/--unrestricted flags have additional effects. This flag can be disabled with --ignore. --no-ignore-dot Don't respect filter rules from .ignore or .rgignore files. This does not impact whether ripgrep will ignore files and directories whose names begin with a dot. For that, see the -./--hidden flag. This flag also does not impact whether filter rules from .gitignore files are respected. This flag can be disabled with --ignore-dot. --no-ignore-exclude Don't respect filter rules from files that are manually configured for the repository. For example, this includes git's .git/info/ex‐ clude. This flag can be disabled with --ignore-exclude. --no-ignore-files When set, any --ignore-file flags, even ones that come after this flag, are ignored. This flag can be disabled with --ignore-files. --no-ignore-global Don't respect filter rules from ignore files that come from "global" sources such as git's core.excludesFile configuration option (which defaults to $HOME/.config/git/ignore). This flag can be disabled with --ignore-global. --no-ignore-parent When this flag is set, filter rules from ignore files found in parent directories are not respected. By default, ripgrep will ascend the parent directories of the current working directory to look for any applicable ignore files that should be applied. In some cases this may not be desirable. This flag can be disabled with --ignore-parent. --no-ignore-vcs When given, filter rules from source control ignore files (e.g., .gitignore) are not respected. By default, ripgrep respects git's ig‐ nore rules for automatic filtering. In some cases, it may not be desirable to respect the source control's ignore rules and instead only respect rules in .ignore or .rgignore. This flag implies --no-ignore-parent for source control ignore files as well. This flag can be disabled with --ignore-vcs. --no-require-git When this flag is given, source control ignore files such as .gitignore are respected even if no git repository is present. By default, ripgrep will only respect filter rules from source control ignore files when ripgrep detects that the search is executed inside a source control repository. For example, when a .git directory is observed. This flag relaxes the default restriction. For example, it might be useful when the contents of a git repository are stored or copied somewhere, but where the repository state is absent. This flag can be disabled with --require-git. --one-file-system When enabled, ripgrep will not cross file system boundaries relative to where the search started from. Note that this applies to each path argument given to ripgrep. For example, in the command rg --one-file-system /foo/bar /quux/baz ripgrep will search both /foo/bar and /quux/baz even if they are on different file systems, but will not cross a file system boundary when traversing each path's directory tree. This is similar to find's -xdev or -mount flag. This flag can be disabled with --no-one-file-system. -t TYPE, --type=TYPE This flag limits ripgrep to searching files matching TYPE. Multiple -t/--type flags may be provided. This flag supports the special value all, which will behave as if -t/--type was provided for every file type supported by ripgrep (in‐ cluding any custom file types). The end result is that --type=all causes ripgrep to search in "whitelist" mode, where it will only search files it recognizes via its type definitions. Note that this flag has lower precedence than both the -g/--glob flag and any rules found in ignore files. To see the list of available file types, use the --type-list flag. -T TYPE, --type-not=TYPE Do not search files matching TYPE. Multiple -T/--type-not flags may be provided. Use the --type-list flag to list all available types. This flag supports the special value all, which will behave as if -T/--type-not was provided for every file type supported by ripgrep (including any custom file types). The end result is that --type-not=all causes ripgrep to search in "blacklist" mode, where it will only search files that are unrecognized by its type definitions. To see the list of available file types, use the --type-list flag. --type-add=TYPESPEC This flag adds a new glob for a particular file type. Only one glob can be added at a time. Multiple --type-add flags can be provided. Unless --type-clear is used, globs are added to any existing globs defined inside of ripgrep. Note that this must be passed to every invocation of ripgrep. Type settings are not persisted. See CONFIGURATION FILES for a workaround. Example: rg --type-add 'foo:*.foo' -tfoo PATTERN This flag can also be used to include rules from other types with the special include directive. The include directive permits specify‐ ing one or more other type names (separated by a comma) that have been defined and its rules will automatically be imported into the type specified. For example, to create a type called src that matches C++, Python and Markdown files, one can use: --type-add 'src:include:cpp,py,md' Additional glob rules can still be added to the src type by using this flag again: --type-add 'src:include:cpp,py,md' --type-add 'src:*.foo' Note that type names must consist only of Unicode letters or numbers. Punctuation characters are not allowed. --type-clear=TYPE Clear the file type globs previously defined for TYPE. This clears any previously defined globs for the TYPE, but globs can be added after this flag. Note that this must be passed to every invocation of ripgrep. Type settings are not persisted. See CONFIGURATION FILES for a workaround. -u, --unrestricted This flag reduces the level of "smart" filtering. Repeated uses (up to 3) reduces the filtering even more. When repeated three times, ripgrep will search every file in a directory tree. A single -u/--unrestricted flag is equivalent to --no-ignore. Two -u/--unrestricted flags is equivalent to --no-ignore -./--hidden. Three -u/--unrestricted flags is equivalent to --no-ignore -./--hidden --binary. The only filtering ripgrep still does when -uuu is given is to skip symbolic links and to avoid printing matches from binary files. Symbolic links can be followed via the -L/--follow flag, and binary files can be treated as text files via the -a/--text flag. OUTPUT OPTIONS -A NUM, --after-context=NUM Show NUM lines after each match. This overrides the --passthru flag and partially overrides the -C/--context flag. -B NUM, --before-context=NUM Show NUM lines before each match. This overrides the --passthru flag and partially overrides the -C/--context flag. --block-buffered When enabled, ripgrep will use block buffering. That is, whenever a matching line is found, it will be written to an in-memory buffer and will not be written to stdout until the buffer reaches a certain size. This is the default when ripgrep's stdout is redirected to a pipeline or a file. When ripgrep's stdout is connected to a tty, line buffering will be used by default. Forcing block buffering can be useful when dumping a large amount of contents to a tty. This overrides the --line-buffered flag. This flag can be disabled with --no-block-buffered. -b, --byte-offset Print the 0-based byte offset within the input file before each line of output. If -o/--only-matching is specified, print the offset of the matched text itself. If ripgrep does transcoding, then the byte offset is in terms of the result of transcoding and not the original data. This applies sim‐ ilarly to other transformations on the data, such as decompression or a --pre filter. This flag can be disabled with --no-byte-offset. --color=WHEN This flag controls when to use colors. The default setting is auto, which means ripgrep will try to guess when to use colors. For exam‐ ple, if ripgrep is printing to a tty, then it will use colors, but if it is redirected to a file or a pipe, then it will suppress color output. ripgrep will suppress color output by default in some other circumstances as well. These include, but are not limited to: • When the TERM environment variable is not set or set to dumb. • When the NO_COLOR environment variable is set (regardless of value). • When flags that imply no use for colors are given. For example, --vimgrep and --json. The possible values for this flag are: never Colors will never be used. auto The default. ripgrep tries to be smart. always Colors will always be used regardless of where output is sent. ansi Like 'always', but emits ANSI escapes (even in a Windows console). This flag also controls whether hyperlinks are emitted. For example, when a hyperlink format is specified, hyperlinks won't be used when color is suppressed. If one wants to emit hyperlinks but no colors, then one must use the --colors flag to manually set all color styles to none: --colors 'path:none' \ --colors 'line:none' \ --colors 'column:none' \ --colors 'match:none' --colors=COLOR_SPEC This flag specifies color settings for use in the output. This flag may be provided multiple times. Settings are applied iteratively. Pre-existing color labels are limited to one of eight choices: red, blue, green, cyan, magenta, yellow, white and black. Styles are limited to nobold, bold, nointense, intense, nounderline or underline. The format of the flag is {type}:{attribute}:{value}. type should be one of path, line, column or match. attribute can be fg, bg or style. value is either a color (for fg and bg) or a text style. A special format, {type}:none, will clear all color settings for type. For example, the following command will change the match color to magenta and the background color for line numbers to yellow: rg --colors 'match:fg:magenta' --colors 'line:bg:yellow' Extended colors can be used for value when the tty supports ANSI color sequences. These are specified as either x (256-color) or x,x,x (24-bit truecolor) where x is a number between 0 and 255 inclusive. x may be given as a normal decimal number or a hexadecimal number, which is prefixed by 0x. For example, the following command will change the match background color to that represented by the rgb value (0,128,255): rg --colors 'match:bg:0,128,255' or, equivalently, rg --colors 'match:bg:0x0,0x80,0xFF' Note that the intense and nointense styles will have no effect when used alongside these extended color codes. --column Show column numbers (1-based). This only shows the column numbers for the first match on each line. This does not try to account for Unicode. One byte is equal to one column. This implies -n/--line-number. When -o/--only-matching is used, then the column numbers written correspond to the start of each match. This flag can be disabled with --no-column. -C NUM, --context=NUM Show NUM lines before and after each match. This is equivalent to providing both the -B/--before-context and -A/--after-context flags with the same value. This overrides the --passthru flag. The -A/--after-context and -B/--before-context flags both partially override this flag, regardless of the order. For example, -A2 -C1 is equivalent to -A2 -B1. --context-separator=SEPARATOR The string used to separate non-contiguous context lines in the output. This is only used when one of the context flags is used (that is, -A/--after-context, -B/--before-context or -C/--context). Escape sequences like \x7F or \t may be used. The default value is --. When the context separator is set to an empty string, then a line break is still inserted. To completely disable context separators, use the --no-context-separator flag. --field-context-separator=SEPARATOR Set the field context separator. This separator is only used when printing contextual lines. It is used to delimit file paths, line numbers, columns and the contextual line itself. The separator may be any number of bytes, including zero. Escape sequences like \x7F or \t may be used. The - character is the default value. --field-match-separator=SEPARATOR Set the field match separator. This separator is only used when printing matching lines. It is used to delimit file paths, line num‐ bers, columns and the matching line itself. The separator may be any number of bytes, including zero. Escape sequences like \x7F or \t may be used. The : character is the default value. --heading This flag prints the file path above clusters of matches from each file instead of printing the file path as a prefix for each matched line. This is the default mode when printing to a tty. When stdout is not a tty, then ripgrep will default to the standard grep-like format. Once can force this format in Unix-like environ‐ ments by piping the output of ripgrep to cat. For example, rg foo | cat. This flag can be disabled with --no-heading. -h, --help This flag prints the help output for ripgrep. Unlike most other flags, the behavior of the short flag, -h, and the long flag, --help, is different. The short flag will show a con‐ densed help output while the long flag will show a verbose help output. The verbose help output has complete documentation, where as the condensed help output will show only a single line for every flag. --hostname-bin=COMMAND This flag controls how ripgrep determines this system's hostname. The flag's value should correspond to an executable (either a path or something that can be found via your system's PATH environment variable). When set, ripgrep will run this executable, with no argu‐ ments, and treat its output (with leading and trailing whitespace stripped) as your system's hostname. When not set (the default, or the empty string), ripgrep will try to automatically detect your system's hostname. On Unix, this corre‐ sponds to calling gethostname. On Windows, this corresponds to calling GetComputerNameExW to fetch the system's "physical DNS host‐ name." ripgrep uses your system's hostname for producing hyperlinks. --hyperlink-format=FORMAT Set the format of hyperlinks to use when printing results. Hyperlinks make certain elements of ripgrep's output, such as file paths, clickable. This generally only works in terminal emulators that support OSC-8 hyperlinks. For example, the format file://{host}{path} will emit an RFC 8089 hyperlink. To see the format that ripgrep is using, pass the --debug flag. Alternatively, a format string may correspond to one of the following aliases: default, none, file, grep+, kitty, macvim, textmate, vs‐ code, vscode-insiders, vscodium. The alias will be replaced with a format string that is intended to work for the corresponding appli‐ cation. The following variables are available in the format string: {path} Required. This is replaced with a path to a matching file. The path is guaranteed to be absolute and percent encoded such that it is valid to put into a URI. Note that a path is guaranteed to start with a /. {host} Optional. This is replaced with your system's hostname. On Unix, this corresponds to calling gethostname. On Windows, this corresponds to calling GetComputerNameExW to fetch the system's "physical DNS hostname." Alternatively, if --hostname-bin was provided, then the hostname returned from the output of that program will be returned. If no hostname could be found, then this variable is replaced with the empty string. {line} Optional. If appropriate, this is replaced with the line number of a match. If no line number is available (for example, if --no-line-number was given), then it is automatically replaced with the value 1. {column} Optional, but requires the presence of {line}. If appropriate, this is replaced with the column number of a match. If no column number is available (for example, if --no-column was given), then it is automatically replaced with the value 1. {wslprefix} Optional. This is a special value that is set to wsl$/WSL_DISTRO_NAME, where WSL_DISTRO_NAME corresponds to the value of the equivalent environment variable. If the system is not Unix or if the WSL_DISTRO_NAME environment variable is not set, then this is replaced with the empty string. A format string may be empty. An empty format string is equivalent to the none alias. In this case, hyperlinks will be disabled. At present, ripgrep does not enable hyperlinks by default. Users must opt into them. If you aren't sure what format to use, try de‐ fault. Like colors, when ripgrep detects that stdout is not connected to a tty, then hyperlinks are automatically disabled, regardless of the value of this flag. Users can pass --color=always to forcefully emit hyperlinks. Note that hyperlinks are only written when a path is also in the output and colors are enabled. To write hyperlinks without colors, you'll need to configure ripgrep to not colorize anything without actually disabling all ANSI escape codes completely: --colors 'path:none' \ --colors 'line:none' \ --colors 'column:none' \ --colors 'match:none' ripgrep works this way because it treats the --color flag as a proxy for whether ANSI escape codes should be used at all. This means that environment variables like NO_COLOR=1 and TERM=dumb not only disable colors, but hyperlinks as well. Similarly, colors and hyper‐ links are disabled when ripgrep is not writing to a tty. (Unless one forces the issue by setting --color=always.) If you're searching a file directly, for example: rg foo path/to/file then hyperlinks will not be emitted since the path given does not appear in the output. To make the path appear, and thus also a hyper‐ link, use the -H/--with-filename flag. For more information on hyperlinks in terminal emulators, see: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda --include-zero When used with -c/--count or --count-matches, this causes ripgrep to print the number of matches for each file even if there were zero matches. This is disabled by default but can be enabled to make ripgrep behave more like grep. This flag can be disabled with --no-include-zero. --line-buffered When enabled, ripgrep will always use line buffering. That is, whenever a matching line is found, it will be flushed to stdout immedi‐ ately. This is the default when ripgrep's stdout is connected to a tty, but otherwise, ripgrep will use block buffering, which is typi‐ cally faster. This flag forces ripgrep to use line buffering even if it would otherwise use block buffering. This is typically useful in shell pipelines, for example: tail -f something.log | rg foo --line-buffered | rg bar This overrides the --block-buffered flag. This flag can be disabled with --no-line-buffered. -n, --line-number Show line numbers (1-based). This is enabled by default when stdout is connected to a tty. This flag can be disabled by -N/--no-line-number. -N, --no-line-number Suppress line numbers. Line numbers are off by default when stdout is not connected to a tty. Line numbers can be forcefully turned on by -n/--line-number. -M NUM, --max-columns=NUM When given, ripgrep will omit lines longer than this limit in bytes. Instead of printing long lines, only the number of matches in that line is printed. When this flag is omitted or is set to 0, then it has no effect. --max-columns-preview Prints a preview for lines exceeding the configured max column limit. When the -M/--max-columns flag is used, ripgrep will by default completely replace any line that is too long with a message indicating that a matching line was removed. When this flag is combined with -M/--max-columns, a preview of the line (corresponding to the limit size) is shown instead, where the part of the line exceeding the limit is not shown. If the -M/--max-columns flag is not set, then this has no effect. This flag can be disabled with --no-max-columns-preview. -0, --null Whenever a file path is printed, follow it with a NUL byte. This includes printing file paths before matches, and when printing a list of matching files such as with -c/--count, -l/--files-with-matches and --files. This option is useful for use with xargs. -o, --only-matching Print only the matched (non-empty) parts of a matching line, with each such part on a separate output line. --path-separator=SEPARATOR Set the path separator to use when printing file paths. This defaults to your platform's path separator, which is / on Unix and \ on Windows. This flag is intended for overriding the default when the environment demands it (e.g., cygwin). A path separator is limited to a single byte. Setting this flag to an empty string reverts it to its default behavior. That is, the path separator is automatically chosen based on the environment. --passthru Print both matching and non-matching lines. Another way to achieve a similar effect is by modifying your pattern to match the empty string. For example, if you are searching using rg foo, then using rg '^|foo' instead will emit every line in every file searched, but only occurrences of foo will be highlighted. This flag enables the same behavior without needing to modify the pattern. An alternative spelling for this flag is --passthrough. This overrides the -C/--context, -A/--after-context and -B/--before-context flags. -p, --pretty This is a convenience alias for --color=always --heading --line-number. This flag is useful when you still want pretty output even if you're piping ripgrep to another program or file. For example: rg -p foo | less -R. -q, --quiet Do not print anything to stdout. If a match is found in a file, then ripgrep will stop searching. This is useful when ripgrep is used only for its exit code (which will be an error code if no matches are found). When --files is used, ripgrep will stop finding files after finding the first file that does not match any ignore rules. -r REPLACEMENT, --replace=REPLACEMENT Replaces every match with the text given when printing results. Neither this flag nor any other ripgrep flag will modify your files. Capture group indices (e.g., $5) and names (e.g., $foo) are supported in the replacement string. Capture group indices are numbered based on the position of the opening parenthesis of the group, where the leftmost such group is $1. The special $0 group corresponds to the entire match. The name of a group is formed by taking the longest string of letters, numbers and underscores (i.e. [_0-9A-Za-z]) after the $. For ex‐ ample, $1a will be replaced with the group named 1a, not the group at index 1. If the group's name contains characters that aren't let‐ ters, numbers or underscores, or you want to immediately follow the group with another string, the name should be put inside braces. For example, ${1}a will take the content of the group at index 1 and append a to the end of it. If an index or name does not refer to a valid capture group, it will be replaced with an empty string. In shells such as Bash and zsh, you should wrap the pattern in single quotes instead of double quotes. Otherwise, capture group indices will be replaced by expanded shell variables which will most likely be empty. To write a literal $, use $$. Note that the replacement by default replaces each match, and not the entire line. To replace the entire line, you should match the en‐ tire line. This flag can be used with the -o/--only-matching flag. --sort=SORTBY This flag enables sorting of results in ascending order. The possible values for this flag are: none (Default) Do not sort results. Fastest. Can be multi-threaded. path Sort by file path. Always single-threaded. The order is determined by sorting files in each directory entry during traver‐ sal. This means that given the files a/b and a+, the latter will sort after the former even though + would normally sort before /. modified Sort by the last modified time on a file. Always single-threaded. accessed Sort by the last accessed time on a file. Always single-threaded. created Sort by the creation time on a file. Always single-threaded. If the chosen (manually or by-default) sorting criteria isn't available on your system (for example, creation time is not available on ext4 file systems), then ripgrep will attempt to detect this, print an error and exit without searching. To sort results in reverse or descending order, use the --sortr flag. Also, this flag overrides --sortr. Note that sorting results currently always forces ripgrep to abandon parallelism and run in a single thread. --sortr=SORTBY This flag enables sorting of results in descending order. The possible values for this flag are: none (Default) Do not sort results. Fastest. Can be multi-threaded. path Sort by file path. Always single-threaded. The order is determined by sorting files in each directory entry during traver‐ sal. This means that given the files a/b and a+, the latter will sort before the former even though + would normally sort after / when doing a reverse lexicographic sort. modified Sort by the last modified time on a file. Always single-threaded. accessed Sort by the last accessed time on a file. Always single-threaded. created Sort by the creation time on a file. Always single-threaded. If the chosen (manually or by-default) sorting criteria isn't available on your system (for example, creation time is not available on ext4 file systems), then ripgrep will attempt to detect this, print an error and exit without searching. To sort results in ascending order, use the --sort flag. Also, this flag overrides --sort. Note that sorting results currently always forces ripgrep to abandon parallelism and run in a single thread. --trim When set, all ASCII whitespace at the beginning of each line printed will be removed. This flag can be disabled with --no-trim. --vimgrep This flag instructs ripgrep to print results with every match on its own line, including line numbers and column numbers. With this option, a line with more than one match will be printed in its entirety more than once. For that reason, the total amount of output as a result of this flag can be quadratic in the size of the input. For example, if the pattern matches every byte in an input file, then each line will be repeated for every byte matched. For this reason, users should only use this flag when there is no other choice. Editor integrations should prefer some other way of reading results from ripgrep, such as via the --json flag. One alternative to avoiding exorbitant memory usage is to force ripgrep into single threaded mode with the -j/--threads flag. Note though that this will not impact the total size of the output, just the heap memory that ripgrep will use. -H, --with-filename This flag instructs ripgrep to print the file path for each matching line. This is the default when more than one file is searched. If --heading is enabled (the default when printing to a tty), the file path will be shown above clusters of matches from each file; other‐ wise, the file name will be shown as a prefix for each matched line. This flag overrides -I/--no-filename. -I, --no-filename This flag instructs ripgrep to never print the file path with each matching line. This is the default when ripgrep is explicitly in‐ structed to search one file or stdin. This flag overrides -H/--with-filename. --sort-files DEPRECATED. Use --sort=path instead. This flag instructs ripgrep to sort search results by file path lexicographically in ascending order. Note that this currently disables all parallelism and runs search in a single thread. This flag overrides --sort and --sortr. This flag can be disabled with --no-sort-files. OUTPUT MODES -c, --count This flag suppresses normal output and shows the number of lines that match the given patterns for each file searched. Each file con‐ taining a match has its path and count printed on each line. Note that unless -U/--multiline is enabled, this reports the number of lines that match and not the total number of matches. In multiline mode, -c/--count is equivalent to --count-matches. If only one file is given to ripgrep, then only the count is printed if there is a match. The -H/--with-filename flag can be used to force printing the file path in this case. If you need a count to be printed regardless of whether there is a match, then use --in‐ clude-zero. This overrides the --count-matches flag. Note that when -c/--count is combined with -o/--only-matching, then ripgrep behaves as if --count-matches was given. --count-matches This flag suppresses normal output and shows the number of individual matches of the given patterns for each file searched. Each file containing matches has its path and match count printed on each line. Note that this reports the total number of individual matches and not the number of lines that match. If only one file is given to ripgrep, then only the count is printed if there is a match. The -H/--with-filename flag can be used to force printing the file path in this case. This overrides the -c/--count flag. Note that when -c/--count is combined with -o/--only-matching, then ripgrep behaves as if --count- matches was given. -l, --files-with-matches Print only the paths with at least one match and suppress match contents. This overrides --files-without-match. --files-without-match Print the paths that contain zero matches and suppress match contents. This overrides -l/--files-with-matches. --json Enable printing results in a JSON Lines format. When this flag is provided, ripgrep will emit a sequence of messages, each encoded as a JSON object, where there are five different message types: begin A message that indicates a file is being searched and contains at least one match. end A message the indicates a file is done being searched. This message also include summary statistics about the search for a particular file. match A message that indicates a match was found. This includes the text and offsets of the match. context A message that indicates a contextual line was found. This includes the text of the line, along with any match information if the search was inverted. summary The final message emitted by ripgrep that contains summary statistics about the search across all files. Since file paths or the contents of files are not guaranteed to be valid UTF-8 and JSON itself must be representable by a Unicode en‐ coding, ripgrep will emit all data elements as objects with one of two keys: text or bytes. text is a normal JSON string when the data is valid UTF-8 while bytes is the base64 encoded contents of the data. The JSON Lines format is only supported for showing search results. It cannot be used with other flags that emit other types of output, such as --files, -l/--files-with-matches, --files-without-match, -c/--count or --count-matches. ripgrep will report an error if any of the aforementioned flags are used in concert with --json. Other flags that control aspects of the standard output such as -o/--only-matching, --heading, -r/--replace, -M/--max-columns, etc., have no effect when --json is set. However, enabling JSON output will always implicitly and unconditionally enable --stats. A more complete description of the JSON format used can be found here: https://docs.rs/grep-printer/*/grep_printer/struct.JSON.html. This flag can be disabled with --no-json. LOGGING OPTIONS --debug Show debug messages. Please use this when filing a bug report. The --debug flag is generally useful for figuring out why ripgrep skipped searching a particular file. The debug messages should men‐ tion all files skipped and why they were skipped. To get even more debug output, use the --trace flag, which implies --debug along with additional trace data. --no-ignore-messages When this flag is enabled, all error messages related to parsing ignore files are suppressed. By default, error messages are printed to stderr. In cases where these errors are expected, this flag can be used to avoid seeing the noise produced by the messages. This flag can be disabled with --ignore-messages. --no-messages This flag suppresses some error messages. Specifically, messages related to the failed opening and reading of files. Error messages re‐ lated to the syntax of the pattern are still shown. This flag can be disabled with --messages. --stats When enabled, ripgrep will print aggregate statistics about the search. When this flag is present, ripgrep will print at least the fol‐ lowing stats to stdout at the end of the search: number of matched lines, number of files with matches, number of files searched, and the time taken for the entire search to complete. This set of aggregate statistics may expand over time. This flag is always and implicitly enabled when --json is used. Note that this flag has no effect if --files, -l/--files-with-matches or --files-without-match is passed. This flag can be disabled with --no-stats. --trace Show trace messages. This shows even more detail than the --debug flag. Generally, one should only use this if --debug doesn't emit the information you're looking for. OTHER BEHAVIORS --files Print each file that would be searched without actually performing the search. This is useful to determine whether a particular file is being searched or not. This overrides --type-list. --generate=KIND This flag instructs ripgrep to generate some special kind of output identified by KIND and then quit without searching. KIND can be one of the following values: man Generates a manual page for ripgrep in the roff format. complete-bash Generates a completion script for the bash shell. complete-zsh Generates a completion script for the zsh shell. complete-fish Generates a completion script for the fish shell. complete-powershell Generates a completion script for PowerShell. The output is written to stdout. The list above may expand over time. --no-config When set, ripgrep will never read configuration files. When this flag is present, ripgrep will not respect the RIPGREP_CONFIG_PATH en‐ vironment variable. If ripgrep ever grows a feature to automatically read configuration files in pre-defined locations, then this flag will also disable that behavior as well. --pcre2-version When this flag is present, ripgrep will print the version of PCRE2 in use, along with other information, and then exit. If PCRE2 is not available, then ripgrep will print an error message and exit with an error code. --type-list Show all supported file types and their corresponding globs. This takes any --type-add and --type-clear flags given into account. Each type is printed on its own line, followed by a : and then a comma-delimited list of globs for that type on the same line. -V, --version This flag prints ripgrep's version. This also may print other relevant information, such as the presence of target specific optimiza‐ tions and the git revision that this build of ripgrep was compiled from. EXIT STATUS If ripgrep finds a match, then the exit status of the program is 0. If no match could be found, then the exit status is 1. If an error oc‐ curred, then the exit status is always 2 unless ripgrep was run with the -q/--quiet flag and a match was found. In summary: • 0 exit status occurs only when at least one match was found, and if no error occurred, unless -q/--quiet was given. • 1 exit status occurs only when no match was found and no error occurred. • 2 exit status occurs when an error occurred. This is true for both catastrophic errors (e.g., a regex syntax error) and for soft errors (e.g., unable to read a file). AUTOMATIC FILTERING ripgrep does a fair bit of automatic filtering by default. This section describes that filtering and how to control it. TIP: To disable automatic filtering, use rg -uuu. ripgrep's automatic "smart" filtering is one of the most apparent differentiating features between ripgrep and other tools like grep. As such, its behavior may be surprising to users that aren't expecting it. ripgrep does four types of filtering automatically: 1. Files and directories that match ignore rules are not searched. 2. Hidden files and directories are not searched. 3. Binary files (files with a NUL byte) are not searched. 4. Symbolic links are not followed. The first type of filtering is the most sophisticated. ripgrep will attempt to respect your gitignore rules as faithfully as possible. In particular, this includes the following: • Any global rules, e.g., in $HOME/.config/git/ignore. • Any rules in relevant .gitignore files. This includes .gitignore files in parent directories that are part of the same git repository. (Unless --no-require-git is given.) • Any local rules, e.g., in .git/info/exclude. In some cases, ripgrep and git will not always be in sync in terms of which files are ignored. For example, a file that is ignored via .gitignore but is tracked by git would not be searched by ripgrep even though git tracks it. This is unlikely to ever be fixed. Instead, you should either make sure your exclude rules match the files you track precisely, or otherwise use git grep for search. Additional ignore rules can be provided outside of a git context: • Any rules in .ignore. ripgrep will also respect .ignore files in parent directories. • Any rules in .rgignore. ripgrep will also respect .rgignore files in parent directories. • Any rules in files specified with the --ignore-file flag. The precedence of ignore rules is as follows, with later items overriding earlier items: • Files given by --ignore-file. • Global gitignore rules, e.g., from $HOME/.config/git/ignore. • Local rules from .git/info/exclude. • Rules from .gitignore. • Rules from .ignore. • Rules from .rgignore. So for example, if foo were in a .gitignore and !foo were in an .rgignore, then foo would not be ignored since .rgignore takes precedence over .gitignore. Each of the types of filtering can be configured via command line flags: • There are several flags starting with --no-ignore that toggle which, if any, ignore rules are respected. --no-ignore by itself will dis‐ able all of them. • -./--hidden will force ripgrep to search hidden files and directories. • --binary will force ripgrep to search binary files. • -L/--follow will force ripgrep to follow symlinks. As a special short hand, the -u flag can be specified up to three times. Each additional time incrementally decreases filtering: • -u is equivalent to --no-ignore. • -uu is equivalent to --no-ignore --hidden. • -uuu is equivalent to --no-ignore --hidden --binary. In particular, rg -uuu should search the same exact content as grep -r. CONFIGURATION FILES ripgrep supports reading configuration files that change ripgrep's default behavior. The format of the configuration file is an "rc" style and is very simple. It is defined by two rules: 1. Every line is a shell argument, after trimming whitespace. 2. Lines starting with # (optionally preceded by any amount of whitespace) are ignored. ripgrep will look for a single configuration file if and only if the RIPGREP_CONFIG_PATH environment variable is set and is non-empty. ripgrep will parse arguments from this file on startup and will behave as if the arguments in this file were prepended to any explicit ar‐ guments given to ripgrep on the command line. Note though that the rg command you run must still be valid. That is, it must always contain at least one pattern at the command line, even if the configuration file uses the -e/--regexp flag. For example, if your ripgreprc file contained a single line: --smart-case then the following command RIPGREP_CONFIG_PATH=wherever/.ripgreprc rg foo would behave identically to the following command: rg --smart-case foo Another example is adding types, like so: --type-add web:*.{html,css,js}* The above would behave identically to the following command: rg --type-add 'web:*.{html,css,js}*' foo The same applies to using globs. This: --glob=!.git or this: --glob !.git would behave identically to the following command: rg --glob '!.git' foo The bottom line is that every shell argument needs to be on its own line. So for example, a config file containing -j 4 is probably not doing what you intend. Instead, you want -j 4 or -j4 ripgrep also provides a flag, --no-config, that when present will suppress any and all support for configuration. This includes any future support for auto-loading configuration files from pre-determined paths. Conflicts between configuration files and explicit arguments are handled exactly like conflicts in the same command line invocation. That is, assuming your config file contains only --smart-case, then this command: RIPGREP_CONFIG_PATH=wherever/.ripgreprc rg foo --case-sensitive is exactly equivalent to rg --smart-case foo --case-sensitive in which case, the --case-sensitive flag would override the --smart-case flag. SHELL COMPLETION Shell completion files are included in the release tarball for Bash, Fish, Zsh and PowerShell. For bash, move rg.bash to $XDG_CONFIG_HOME/bash_completion or /etc/bash_completion.d/. For fish, move rg.fish to $HOME/.config/fish/completions. For zsh, move _rg to one of your $fpath directories. CAVEATS ripgrep may abort unexpectedly when using default settings if it searches a file that is simultaneously truncated. This behavior can be avoided by passing the --no-mmap flag which will forcefully disable the use of memory maps in all cases. ripgrep may use a large amount of memory depending on a few factors. Firstly, if ripgrep uses parallelism for search (the default), then the entire output for each individual file is buffered into memory in order to prevent interleaving matches in the output. To avoid this, you can disable parallelism with the -j1 flag. Secondly, ripgrep always needs to have at least a single line in memory in order to execute a search. A file with a very long line can thus cause ripgrep to use a lot of memory. Generally, this only occurs when searching binary data with the -a/--text flag enabled. (When the -a/--text flag isn't enabled, ripgrep will replace all NUL bytes with line terminators, which typically prevents exorbitant memory usage.) Thirdly, when ripgrep searches a large file using a memory map, the process will likely report its resident memory usage as the size of the file. However, this does not mean ripgrep actually needed to use that much heap memory; the operating system will generally handle this for you. VERSION 14.1.0 HOMEPAGE https://github.com/BurntSushi/ripgrep Please report bugs and feature requests to the issue tracker. Please do your best to provide a reproducible test case for bugs. This should include the corpus being searched, the rg command, the actual output and the expected output. Please also include the output of running the same rg command but with the --debug flag. If you have questions that don't obviously fall into the "bug" or "feature request" category, then they are welcome in the Discussions sec‐ tion of the issue tracker: https://github.com/BurntSushi/ripgrep/discussions. AUTHORS Andrew Gallant <[email protected]> 14.1.0 2023-11-26 RG(1)

はじめに よく忘れるのでメモ。 grepではなく、rg(ripgrep)などが今ではよく使われると思うが、grepの方がまだ手元にある環境が多い(あるいは、昔のスクリプトのメンテなどではgrepを読むことが多い)と思うのでgrepをメモする。 grep コマンド チートシート 概要 grep コマンドは、指定したパターンに一致する行をファイルや標準入力から検索するツール。 基本的な使い方 指定した文字列をファイル内で検索する。 grep "pattern" file.txt 複数のファイルを対象に検索する。 grep "pattern" file1.txt file2.txt ディレクトリ内のすべてのファイルを再帰的に検索する。 grep -r "pattern" directory/ 正規表現を使用した検索 拡張正規表現を使用して検索する。 grep -E "pattern|another" file.txt 文字列の先頭にあるパターンを検索する。 grep "^pattern" file.txt 文字列の末尾にあるパターンを検索する。 grep "pattern$" file.txt 出力オプション 検索結果の行番号を表示する。 grep -n "pattern" file.txt 一致した部分のみを表示する。 grep -o "pattern" file.txt 一致した行数を表示する。 grep -c "pattern" file.txt 一致しない行を表示する (逆マッチ)。 grep -v "pattern" file.txt 大文字小文字を無視した検索 大文字小文字を区別せずに検索する。 grep -i "pattern" file.txt 複数のパターンを検索 複数のパターンを指定して検索する。 grep -e "pattern1" -e "pattern2" file.txt コンテキストを表示 一致する行の前後の行も表示する。 grep -C 3 "pattern" file.txt 一致する行の前の行を表示する。 grep -B 3 "pattern" file.txt 一致する行の後の行を表示する。 ...

はじめに よくオプションを忘れるのでメモ find コマンド チートシート 概要 find コマンドは、ディレクトリツリーを再帰的に検索し、特定の条件に一致するファイルやディレクトリを見つけるためのツール。 基本的な使い方 ディレクトリ全体を検索する。 find <directory> 名前で検索 特定の名前のファイルを検索する。 find <directory> -name "<filename>" 大文字小文字を区別せずに検索する。 find <directory> -iname "<filename>" 拡張子で検索 特定の拡張子のファイルを検索する。 find <directory> -name "*.txt" サイズで検索 特定のサイズ以上のファイルを検索する (例: 10MB以上)。 find <directory> -size +10M 特定のサイズ以下のファイルを検索する (例: 100KB以下)。 find <directory> -size -100k 日時で検索 過去7日以内に変更されたファイルを検索する。 find <directory> -mtime -7 過去24時間以内にアクセスされたファイルを検索する。 find <directory> -atime -1 パーミッションで検索 特定のパーミッションを持つファイルを検索する (例: 777)。 find <directory> -perm 777 特定のユーザー所有のファイルを検索する。 find <directory> -user <username> 特定のグループ所有のファイルを検索する。 find <directory> -group <groupname> 実行コマンドと組み合わせ 見つかったファイルを削除する。 ...

はじめに よく忘れるのでメモ 使い方 tcpdump -i <ネットワークインターフェース> 前提 ネットワークインターフェースを流れる通信を捕捉。1行は1つのパケットを表す。 なお、デフォルトではパケットのデータをプロトコルごとに異なる形で加工して表示する。 つまり、プロトコルごとにパケットの解析方法があり、それに従って解析した結果を出力している。 -Xをつけると、生のバイナリが見られる。 見方 TCPパケットの場合の例 13:45:32.123456 IP 192.168.1.10.12345 > 192.168.1.1.80: Flags [S], seq 0, win 65535, options [mss 1460], length 0 説明 13:45:32.123456 -> タイムスタンプ。HH:MM:SS.microseconds形式。日付は入らない。 IP -> プロトコル 192.168.1.10.12345 > 192.168.1.1.80 -> 送信元IPアドレス.送信元ポート番号 > 宛先IPアドレス.宛先ポート番号 ただし、 <IPドメイン>.<プロトコル>と表示される場合もある。 例えば、 nrt13s55-in-f4.1e100.net.httpsなど。nrt13s55-in-f4.1e100.netがIPドメイン、httpsは443を表す。 リバースDNSによるもので、オフにしたければ-nオプションをつける。(sudo tcpdump -i eth0 -n)。あるいは、.domainはポート53を表す。/etc/servicesに対応がある。 Ubuntuの公式イメージには、etc/servicesが入っていなかったので、(ref: https://qiita.com/hogegex/items/76814031b8b1ed3af37a)alpineで代用。手元のUbuntuマシンには、いつの間にか入っていました。 docker run alpine:3.21.0 cat /etc/services # Network services, Internet style # # Updated from https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml . # # New ports will be added on request if they have been officially assigned # by IANA and used in the real-world or are needed by a debian package. # If you need a huge list of used numbers please install the nmap package. tcpmux 1/tcp # TCP port service multiplexer echo 7/tcp echo 7/udp discard 9/tcp sink null discard 9/udp sink null systat 11/tcp users daytime 13/tcp daytime 13/udp netstat 15/tcp qotd 17/tcp quote chargen 19/tcp ttytst source chargen 19/udp ttytst source ftp-data 20/tcp ftp 21/tcp fsp 21/udp fspd ssh 22/tcp # SSH Remote Login Protocol telnet 23/tcp smtp 25/tcp mail time 37/tcp timserver time 37/udp timserver whois 43/tcp nicname tacacs 49/tcp # Login Host Protocol (TACACS) tacacs 49/udp domain 53/tcp # Domain Name Server domain 53/udp bootps 67/udp bootpc 68/udp tftp 69/udp gopher 70/tcp # Internet Gopher finger 79/tcp http 80/tcp www # WorldWideWeb HTTP kerberos 88/tcp kerberos5 krb5 kerberos-sec # Kerberos v5 kerberos 88/udp kerberos5 krb5 kerberos-sec # Kerberos v5 iso-tsap 102/tcp tsap # part of ISODE acr-nema 104/tcp dicom # Digital Imag. & Comm. 300 pop3 110/tcp pop-3 # POP version 3 sunrpc 111/tcp portmapper # RPC 4.0 portmapper sunrpc 111/udp portmapper auth 113/tcp authentication tap ident nntp 119/tcp readnews untp # USENET News Transfer Protocol ntp 123/udp # Network Time Protocol epmap 135/tcp loc-srv # DCE endpoint resolution netbios-ns 137/udp # NETBIOS Name Service netbios-dgm 138/udp # NETBIOS Datagram Service netbios-ssn 139/tcp # NETBIOS session service imap2 143/tcp imap # Interim Mail Access P 2 and 4 snmp 161/tcp # Simple Net Mgmt Protocol snmp 161/udp snmp-trap 162/tcp snmptrap # Traps for SNMP snmp-trap 162/udp snmptrap cmip-man 163/tcp # ISO mgmt over IP (CMOT) cmip-man 163/udp cmip-agent 164/tcp cmip-agent 164/udp mailq 174/tcp # Mailer transport queue for Zmailer xdmcp 177/udp # X Display Manager Control Protocol bgp 179/tcp # Border Gateway Protocol smux 199/tcp # SNMP Unix Multiplexer qmtp 209/tcp # Quick Mail Transfer Protocol z3950 210/tcp wais # NISO Z39.50 database ipx 213/udp # IPX [RFC1234] ptp-event 319/udp ptp-general 320/udp pawserv 345/tcp # Perf Analysis Workbench zserv 346/tcp # Zebra server rpc2portmap 369/tcp rpc2portmap 369/udp # Coda portmapper codaauth2 370/tcp codaauth2 370/udp # Coda authentication server clearcase 371/udp Clearcase ldap 389/tcp # Lightweight Directory Access Protocol ldap 389/udp svrloc 427/tcp # Server Location svrloc 427/udp https 443/tcp # http protocol over TLS/SSL https 443/udp # HTTP/3 snpp 444/tcp # Simple Network Paging Protocol microsoft-ds 445/tcp # Microsoft Naked CIFS kpasswd 464/tcp kpasswd 464/udp submissions 465/tcp ssmtp smtps urd # Submission over TLS [RFC8314] saft 487/tcp # Simple Asynchronous File Transfer isakmp 500/udp # IPSEC key management rtsp 554/tcp # Real Time Stream Control Protocol rtsp 554/udp nqs 607/tcp # Network Queuing system asf-rmcp 623/udp # ASF Remote Management and Control Protocol qmqp 628/tcp ipp 631/tcp # Internet Printing Protocol ldp 646/tcp # Label Distribution Protocol ldp 646/udp # # UNIX specific services # exec 512/tcp biff 512/udp comsat login 513/tcp who 513/udp whod shell 514/tcp cmd syslog # no passwords used syslog 514/udp printer 515/tcp spooler # line printer spooler talk 517/udp ntalk 518/udp route 520/udp router routed # RIP gdomap 538/tcp # GNUstep distributed objects gdomap 538/udp uucp 540/tcp uucpd # uucp daemon klogin 543/tcp # Kerberized `rlogin' (v5) kshell 544/tcp krcmd # Kerberized `rsh' (v5) dhcpv6-client 546/udp dhcpv6-server 547/udp afpovertcp 548/tcp # AFP over TCP nntps 563/tcp snntp # NNTP over SSL submission 587/tcp # Submission [RFC4409] ldaps 636/tcp # LDAP over SSL ldaps 636/udp tinc 655/tcp # tinc control port tinc 655/udp silc 706/tcp kerberos-adm 749/tcp # Kerberos `kadmin' (v5) # domain-s 853/tcp # DNS over TLS [RFC7858] domain-s 853/udp # DNS over DTLS [RFC8094] rsync 873/tcp ftps-data 989/tcp # FTP over SSL (data) ftps 990/tcp telnets 992/tcp # Telnet over SSL imaps 993/tcp # IMAP over SSL pop3s 995/tcp # POP-3 over SSL # # From ``Assigned Numbers'': # #> The Registered Ports are not controlled by the IANA and on most systems #> can be used by ordinary user processes or programs executed by ordinary #> users. # #> Ports are used in the TCP [45,106] to name the ends of logical #> connections which carry long term conversations. For the purpose of #> providing services to unknown callers, a service contact port is #> defined. This list specifies the port used by the server process as its #> contact port. While the IANA can not control uses of these ports it #> does register or list uses of these ports as a convienence to the #> community. # socks 1080/tcp # socks proxy server proofd 1093/tcp rootd 1094/tcp openvpn 1194/tcp openvpn 1194/udp rmiregistry 1099/tcp # Java RMI Registry lotusnote 1352/tcp lotusnotes # Lotus Note ms-sql-s 1433/tcp # Microsoft SQL Server ms-sql-m 1434/udp # Microsoft SQL Monitor ingreslock 1524/tcp datametrics 1645/tcp old-radius datametrics 1645/udp old-radius sa-msg-port 1646/tcp old-radacct sa-msg-port 1646/udp old-radacct kermit 1649/tcp groupwise 1677/tcp l2f 1701/udp l2tp radius 1812/tcp radius 1812/udp radius-acct 1813/tcp radacct # Radius Accounting radius-acct 1813/udp radacct cisco-sccp 2000/tcp # Cisco SCCP nfs 2049/tcp # Network File System nfs 2049/udp # Network File System gnunet 2086/tcp gnunet 2086/udp rtcm-sc104 2101/tcp # RTCM SC-104 IANA 1/29/99 rtcm-sc104 2101/udp gsigatekeeper 2119/tcp gris 2135/tcp # Grid Resource Information Server cvspserver 2401/tcp # CVS client/server operations venus 2430/tcp # codacon port venus 2430/udp # Venus callback/wbc interface venus-se 2431/tcp # tcp side effects venus-se 2431/udp # udp sftp side effect codasrv 2432/tcp # not used codasrv 2432/udp # server port codasrv-se 2433/tcp # tcp side effects codasrv-se 2433/udp # udp sftp side effect mon 2583/tcp # MON traps mon 2583/udp dict 2628/tcp # Dictionary server f5-globalsite 2792/tcp gsiftp 2811/tcp gpsd 2947/tcp gds-db 3050/tcp gds_db # InterBase server icpv2 3130/udp icp # Internet Cache Protocol isns 3205/tcp # iSNS Server Port isns 3205/udp # iSNS Server Port iscsi-target 3260/tcp mysql 3306/tcp ms-wbt-server 3389/tcp nut 3493/tcp # Network UPS Tools nut 3493/udp distcc 3632/tcp # distributed compiler daap 3689/tcp # Digital Audio Access Protocol svn 3690/tcp subversion # Subversion protocol suucp 4031/tcp # UUCP over SSL sysrqd 4094/tcp # sysrq daemon sieve 4190/tcp # ManageSieve Protocol epmd 4369/tcp # Erlang Port Mapper Daemon remctl 4373/tcp # Remote Authenticated Command Service f5-iquery 4353/tcp # F5 iQuery ntske 4460/tcp # Network Time Security Key Establishment ipsec-nat-t 4500/udp # IPsec NAT-Traversal [RFC3947] iax 4569/udp # Inter-Asterisk eXchange mtn 4691/tcp # monotone Netsync Protocol radmin-port 4899/tcp # RAdmin Port sip 5060/tcp # Session Initiation Protocol sip 5060/udp sip-tls 5061/tcp sip-tls 5061/udp xmpp-client 5222/tcp jabber-client # Jabber Client Connection xmpp-server 5269/tcp jabber-server # Jabber Server Connection cfengine 5308/tcp mdns 5353/udp # Multicast DNS postgresql 5432/tcp postgres # PostgreSQL Database freeciv 5556/tcp rptp # Freeciv gameplay amqps 5671/tcp # AMQP protocol over TLS/SSL amqp 5672/tcp amqp 5672/sctp x11 6000/tcp x11-0 # X Window System x11-1 6001/tcp x11-2 6002/tcp x11-3 6003/tcp x11-4 6004/tcp x11-5 6005/tcp x11-6 6006/tcp x11-7 6007/tcp gnutella-svc 6346/tcp # gnutella gnutella-svc 6346/udp gnutella-rtr 6347/tcp # gnutella gnutella-rtr 6347/udp redis 6379/tcp sge-qmaster 6444/tcp sge_qmaster # Grid Engine Qmaster Service sge-execd 6445/tcp sge_execd # Grid Engine Execution Service mysql-proxy 6446/tcp # MySQL Proxy babel 6696/udp # Babel Routing Protocol ircs-u 6697/tcp # Internet Relay Chat via TLS/SSL bbs 7000/tcp afs3-fileserver 7000/udp afs3-callback 7001/udp # callbacks to cache managers afs3-prserver 7002/udp # users & groups database afs3-vlserver 7003/udp # volume location database afs3-kaserver 7004/udp # AFS/Kerberos authentication afs3-volser 7005/udp # volume managment server afs3-bos 7007/udp # basic overseer process afs3-update 7008/udp # server-to-server updater afs3-rmtsys 7009/udp # remote cache manager service font-service 7100/tcp xfs # X Font Service http-alt 8080/tcp webcache # WWW caching service puppet 8140/tcp # The Puppet master service bacula-dir 9101/tcp # Bacula Director bacula-fd 9102/tcp # Bacula File Daemon bacula-sd 9103/tcp # Bacula Storage Daemon xmms2 9667/tcp # Cross-platform Music Multiplexing System nbd 10809/tcp # Linux Network Block Device zabbix-agent 10050/tcp # Zabbix Agent zabbix-trapper 10051/tcp # Zabbix Trapper amanda 10080/tcp # amanda backup services dicom 11112/tcp hkp 11371/tcp # OpenPGP HTTP Keyserver db-lsp 17500/tcp # Dropbox LanSync Protocol dcap 22125/tcp # dCache Access Protocol gsidcap 22128/tcp # GSI dCache Access Protocol wnn6 22273/tcp # wnn6 # # Datagram Delivery Protocol services # rtmp 1/ddp # Routing Table Maintenance Protocol nbp 2/ddp # Name Binding Protocol echo 4/ddp # AppleTalk Echo Protocol zip 6/ddp # Zone Information Protocol #========================================================================= # The remaining port numbers are not as allocated by IANA. #========================================================================= # Kerberos (Project Athena/MIT) services kerberos4 750/udp kerberos-iv kdc # Kerberos (server) kerberos4 750/tcp kerberos-iv kdc kerberos-master 751/udp kerberos_master # Kerberos authentication kerberos-master 751/tcp passwd-server 752/udp passwd_server # Kerberos passwd server krb-prop 754/tcp krb_prop krb5_prop hprop # Kerberos slave propagation zephyr-srv 2102/udp # Zephyr server zephyr-clt 2103/udp # Zephyr serv-hm connection zephyr-hm 2104/udp # Zephyr hostmanager iprop 2121/tcp # incremental propagation supfilesrv 871/tcp # Software Upgrade Protocol server supfiledbg 1127/tcp # Software Upgrade Protocol debugging # # Services added for the Debian GNU/Linux distribution # poppassd 106/tcp # Eudora moira-db 775/tcp moira_db # Moira database moira-update 777/tcp moira_update # Moira update protocol moira-ureg 779/udp moira_ureg # Moira user registration spamd 783/tcp # spamassassin daemon skkserv 1178/tcp # skk jisho server port predict 1210/udp # predict -- satellite tracking rmtcfg 1236/tcp # Gracilis Packeten remote config server xtel 1313/tcp # french minitel xtelw 1314/tcp # french minitel zebrasrv 2600/tcp # zebra service zebra 2601/tcp # zebra vty ripd 2602/tcp # ripd vty (zebra) ripngd 2603/tcp # ripngd vty (zebra) ospfd 2604/tcp # ospfd vty (zebra) bgpd 2605/tcp # bgpd vty (zebra) ospf6d 2606/tcp # ospf6d vty (zebra) ospfapi 2607/tcp # OSPF-API isisd 2608/tcp # ISISd vty (zebra) fax 4557/tcp # FAX transmission service (old) hylafax 4559/tcp # HylaFAX client-server protocol (new) munin 4949/tcp lrrd # Munin rplay 5555/udp # RPlay audio service nrpe 5666/tcp # Nagios Remote Plugin Executor nsca 5667/tcp # Nagios Agent - NSCA canna 5680/tcp # cannaserver syslog-tls 6514/tcp # Syslog over TLS [RFC5425] sane-port 6566/tcp sane saned # SANE network scanner daemon ircd 6667/tcp # Internet Relay Chat zope-ftp 8021/tcp # zope management by ftp tproxy 8081/tcp # Transparent Proxy omniorb 8088/tcp # OmniORB clc-build-daemon 8990/tcp # Common lisp build daemon xinetd 9098/tcp git 9418/tcp # Git Version Control System zope 9673/tcp # zope server webmin 10000/tcp kamanda 10081/tcp # amanda backup services (Kerberos) amandaidx 10082/tcp # amanda backup services amidxtape 10083/tcp # amanda backup services sgi-cmsd 17001/udp # Cluster membership services daemon sgi-crsd 17002/udp sgi-gcd 17003/udp # SGI Group membership daemon sgi-cad 17004/tcp # Cluster Admin daemon binkp 24554/tcp # binkp fidonet protocol asp 27374/tcp # Address Search Protocol asp 27374/udp csync2 30865/tcp # cluster synchronization tool dircproxy 57000/tcp # Detachable IRC Proxy tfido 60177/tcp # fidonet EMSI over telnet fido 60179/tcp # fidonet EMSI over TCP # Local services Flags [S] -> フラグ TCPヘッダーのフラグを表示。 S: SYN (接続開始)。 F: FIN (接続終了)。 P: PUSH (優先データ送信)。 R: RST (接続リセット)。 A: ACK (確認応答)。 .: データ転送中。 ...

はじめに よく忘れるのでメモ xxd コマンド チートシート 概要 xxd コマンドは、バイナリデータを16進ダンプとして表示したり、逆に16進ダンプからバイナリデータに変換するツール。 16進ダンプの表示 指定したファイルのバイナリデータを16進ダンプとして表示する。 xxd <file> 出力を1行あたり8バイト単位に変更する。 xxd -c 8 <file> オフセットを非表示にする。 xxd -p <file> 16進ダンプをバイナリに変換 16進ダンプをバイナリに変換する。 xxd -r -p <hex_file> <output_file> xxd の標準出力を xxd -r にパイプで渡して元のデータを復元する。 下記で、fileとoutput_fileは完全に一致する。 xxd <file> | xxd -r > <output_file> 16進ダンプの一部を表示 指定したバイト数だけ出力する (例: 16バイトのみ表示)。 xxd -l 16 <file> 指定したオフセットから16バイト表示する。 xxd -s 0x10 -l 16 <file> (0xプレフィックスで16進数を指定できるのは便利) ビット単位の表示 バイナリデータをビット単位で表示する。 xxd -b <file> これと-pを組み合わせたところ、-bより-pが後の場合でのみ、正しくplainモードになった。順番が大事なよう。 よく使うオプション 説明 オプション 16進ダンプを表示 xxd <file> 1行のバイト数を指定 -c <bytes> オフセットを省略 -p 16進ダンプをバイナリに変換 -r 指定バイト数のみ出力 -l <length> 指定オフセットから出力 -s <offset> ビット単位で表示 -b 個人的によく使うオプション ASCIIや、行番号を表示しないには -p,--plain ...

はじめに ARP の仕様についてメモ。 ARPとは IPv4で使われる仕様。L2レイヤーにおいて、つまり同一リンクにおいて、送信したい先のIPアドレスから、MACアドレスを引くための仕組み。 流れ 1．L2のブロードキャストアドレスを指定してそのL2の隣接しているマシンへパケットを送付すると、リンク上の全てにリクエストが伝播する。 これを利用して、ARPリクエストをリンク上の全てのデバイスへ送ることができる。 つまり、L2ブロードキャストアドレス(基本的に、どの環境でもff:ff:ff:ff:ff:ff)を宛先にして、ARPリクエストを自分のNICから送信する。 ARPリクエストは、L2ヘッダとARPリクエストの本体からなる(L3ヘッダはない)。 L2ヘッダfromには、送信元のマシンのMACアドレス、L2ヘッダtoにはブロードキャストアドレス、ARPリクエスト本体にはクエリ内容(つまり、MACアドレスを知りたいIPアドレス)を記載する。 2．arpリクエストを受け取ったマシンは、arpリクエストに書かれたクエリのIPアドレスと自身のIPアドレスが一致している場合、自身のMACアドレスをARPレスポンスとして返す。 (ここで、自身のIPアドレスと異なるIPアドレスなのに、自身がMACアドレスを返すことを、ARPスプーフィングという。) ARPレスポンスは、L2ヘッダとARPレスポンスの本体からなる。 L2ヘッダsourceのMACアドレスにはARPレスポンスを返しているMACアドレス、L2ヘッダのdestinationには、クエリの発行元のMACアドレス、ARPレスポンスの本体にはARPレスポンスを返したMACアドレス(つまり、クエリの結果)を書く。 一方、IPv6で使われる技術 ARPに代わり、Neighbor Discovery Protocolが使われる。 Neighbor Solicitation (NS)が使われるみたい。 送信元のIPv6アドレスから宛先のIPv6アドレスに対するMACアドレスを知りたいときに送る。 宛先のリンクローカルマルチキャスト (ff02::1:ffxx:xxxx) を使う Neighbor Advertisement (NA) 宛先のIPv6アドレスを持つデバイスが応答し、自分のMACアドレスを通知。 arp コマンド チートシート ARP テーブルの表示 現在の ARP テーブルを表示する。 arp -a 特定のインターフェースの ARP テーブルを表示する。 arp -i <INTERFACE> ARP エントリの追加 特定の IP アドレスと MAC アドレスの関連付けを手動で追加する。 arp -s <IP_ADDRESS> <MAC_ADDRESS> インターフェースを指定して ARP エントリを追加する。 arp -s <IP_ADDRESS> <MAC_ADDRESS> -i <INTERFACE> ARP エントリの削除 指定した IP アドレスの ARP エントリを削除する。 ...

はじめに よく忘れるのでメモ。 journalctl チートシート 概要 journalctl コマンドは、systemd のジャーナルログを管理・表示するためのツール。 ログの表示 すべてのログを表示する。 journalctl 最新のログをリアルタイムで表示する。 journalctl -f 指定したブートのログを表示する。 journalctl -b 特定のユニット (unit_name.service) のログを表示する。 journalctl -u <unit_name.service> 特定の日付以降のログを表示する。 journalctl --since "2024-01-01 00:00:00" 特定の日付範囲のログを表示する。 journalctl --since "2024-01-01" --until "2024-01-02" フィルタリング 特定のプロセス ID (PID) のログを表示する。 journalctl _PID=<PID> 特定のユーザー ID (UID) のログを表示する。 journalctl _UID=<UID> 特定のエラーレベル以上のログを表示する。 journalctl -p <PRIORITY> エラーレベルの例: 優先度 説明 0 emerg (緊急) 1 alert (警告) 2 crit (重大) 3 err (エラー) 4 warning (警告) 5 notice (注意) 6 info (情報) 7 debug (デバッグ) ログの管理 ログのサイズを確認する。 ...

はじめに systemctlは便利でよく使うが、たまにしか使わないオプションなどもあり忘れやすいのでメモ。 systemctl コマンドチートシート サービスの管理 # サービスを開始 sudo systemctl start <service> # サービスを停止 sudo systemctl stop <service> # サービスを再起動 sudo systemctl restart <service> # サービスの状態を確認 systemctl status <service> # サービスを有効化（起動時に自動実行） sudo systemctl enable <service> # サービスを無効化（起動時に実行しない） sudo systemctl disable <service> # サービスの有効/無効状態を確認 systemctl is-enabled <service> # サービスをリロード（設定ファイルの再読込） sudo systemctl reload <service> # サービスの強制リロード（再起動せずに設定を反映） sudo systemctl reload-or-restart <service> ユニットの管理 # 実行中のユニットを一覧表示 systemctl list-units # すべてのユニット（失敗含む）を一覧表示 systemctl list-units --all # 失敗したユニットを一覧表示(これ便利) systemctl --failed # ユニットファイルのリロード（新しいユニットファイルを適用） sudo systemctl daemon-reload # サービスの依存関係を表示 systemctl list-dependencies <service> システムの管理 # システムを再起動 sudo systemctl reboot # システムをシャットダウン sudo systemctl poweroff # システムをスリープ sudo systemctl suspend # システムを休止状態にする sudo systemctl hibernate タイマーの管理 # 有効なタイマーの一覧を表示 systemctl list-timers # 指定したタイマーの状態を表示 systemctl status <timer> # タイマーを開始 sudo systemctl start <timer> # タイマーを停止 sudo systemctl stop <timer> # タイマーを有効化（起動時に自動実行） sudo systemctl enable <timer> # タイマーを無効化 sudo systemctl disable <timer> systemd ユーザーモード # ユーザーモードでのサービスを管理（ユーザーごとの systemd） systemctl --user start <service> systemctl --user stop <service> systemctl --user enable <service> systemctl --user disable <service> systemctl --user status <service> # ユーザー用のユニットをリロード\ssystemctl --user daemon-reload man systemctl より引用 SYSTEMCTL(1) systemctl SYSTEMCTL(1) NAME systemctl - Control the systemd system and service manager SYNOPSIS systemctl [OPTIONS...] COMMAND [UNIT...] DESCRIPTION systemctl may be used to introspect and control the state of the "systemd" system and service manager. Please refer to systemd(1) for an introduction into the basic concepts and functionality this tool manages. COMMANDS The following commands are understood: Unit Commands (Introspection and Modification) list-units [PATTERN...] List units that systemd currently has in memory. This includes units that are either referenced directly or through a dependency, units that are pinned by applications programmatically, or units that were active in the past and have failed. By default only units which are active, have pending jobs, or have failed are shown; this can be changed with option --all. If one or more PATTERNs are specified, only units matching one of them are shown. The units that are shown are additionally filtered by --type= and --state= if those options are specified. Note that this command does not show unit templates, but only instances of unit templates. Units templates that aren't instantiated are not runnable, and will thus never show up in the output of this command. Specifically this means that [email protected] will never be shown in this list — unless instantiated, e.g. as [email protected]. Use list-unit-files (see below) for listing installed unit template files. Produces output similar to UNIT LOAD ACTIVE SUB DESCRIPTION sys-module-fuse.device loaded active plugged /sys/module/fuse -.mount loaded active mounted Root Mount boot-efi.mount loaded active mounted /boot/efi systemd-journald.service loaded active running Journal Service systemd-logind.service loaded active running Login Service ● [email protected] loaded failed failed User Manager for UID 1000 ... systemd-tmpfiles-clean.timer loaded active waiting Daily Cleanup of Temporary Directories LOAD = Reflects whether the unit definition was properly loaded. ACTIVE = The high-level unit activation state, i.e. generalization of SUB. SUB = The low-level unit activation state, values depend on unit type. 123 loaded units listed. Pass --all to see loaded but inactive units, too. To show all installed unit files use 'systemctl list-unit-files'. The header and the last unit of a given type are underlined if the terminal supports that. A colored dot is shown next to services which were masked, not found, or otherwise failed. The LOAD column shows the load state, one of loaded, not-found, bad-setting, error, masked. The ACTIVE columns shows the general unit state, one of active, reloading, inactive, failed, activating, deactivating. The SUB column shows the unit-type-specific detailed state of the unit, possible values vary by unit type. The list of possible LOAD, ACTIVE, and SUB states is not constant and new systemd releases may both add and remove values. systemctl --state=help command may be used to display the current set of possible values. This is the default command. list-automounts [PATTERN...] List automount units currently in memory, ordered by mount path. If one or more PATTERNs are specified, only automount units matching one of them are shown. Produces output similar to WHAT WHERE MOUNTED IDLE TIMEOUT UNIT /dev/sdb1 /mnt/test no 120s mnt-test.automount binfmt_misc /proc/sys/fs/binfmt_misc yes 0 proc-sys-fs-binfmt_misc.automount 2 automounts listed. Also see --show-types, --all, and --state=. Added in version 252. list-paths [PATTERN...] List path units currently in memory, ordered by path. If one or more PATTERNs are specified, only path units matching one of them are shown. Produces output similar to PATH CONDITION UNIT ACTIVATES /run/systemd/ask-password DirectoryNotEmpty systemd-ask-password-plymouth.path systemd-ask-password-plymouth.service /run/systemd/ask-password DirectoryNotEmpty systemd-ask-password-wall.path systemd-ask-password-wall.service /var/cache/cups/org.cups.cupsd PathExists cups.path cups.service 3 paths listed. Also see --show-types, --all, and --state=. Added in version 254. list-sockets [PATTERN...] List socket units currently in memory, ordered by listening address. If one or more PATTERNs are specified, only socket units matching one of them are shown. Produces output similar to LISTEN UNIT ACTIVATES /dev/initctl systemd-initctl.socket systemd-initctl.service ... [::]:22 sshd.socket sshd.service kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service 5 sockets listed. Note: because the addresses might contains spaces, this output is not suitable for programmatic consumption. Also see --show-types, --all, and --state=. Added in version 202. list-timers [PATTERN...] List timer units currently in memory, ordered by the time they elapse next. If one or more PATTERNs are specified, only units matching one of them are shown. Produces output similar to NEXT LEFT LAST PASSED UNIT ACTIVATES - - Thu 2017-02-23 13:40:29 EST 3 days ago ureadahead-stop.timer ureadahead-stop.service Sun 2017-02-26 18:55:42 EST 1min 14s left Thu 2017-02-23 13:54:44 EST 3 days ago systemd-tmpfiles-clean.timer systemd-tmpfiles-clean.service Sun 2017-02-26 20:37:16 EST 1h 42min left Sun 2017-02-26 11:56:36 EST 6h ago apt-daily.timer apt-daily.service Sun 2017-02-26 20:57:49 EST 2h 3min left Sun 2017-02-26 11:56:36 EST 6h ago snapd.refresh.timer snapd.refresh.service NEXT shows the next time the timer will run. LEFT shows how long till the next time the timer runs. LAST shows the last time the timer ran. PASSED shows how long has passed since the timer last ran. UNIT shows the name of the timer ACTIVATES shows the name the service the timer activates when it runs. Also see --all and --state=. Added in version 209. is-active PATTERN... Check whether any of the specified units are active (i.e. running). Returns an exit code 0 if at least one is active, or non-zero otherwise. Unless --quiet is specified, this will also print the current unit state to standard output. is-failed [PATTERN...] Check whether any of the specified units is in the "failed" state. If no unit is specified, check whether there are any failed units, which corresponds to the "degraded" state returned by is-system-running. Returns an exit code 0 if at least one has failed, non-zero otherwise. Unless --quiet is specified, this will also print the current unit or system state to standard output. Added in version 197. status [PATTERN...|PID...]] Show runtime status information about the whole system or about one or more units followed by most recent log data from the journal. If no positional arguments are specified, and no unit filter is given with --type=, --state=, or --failed, shows the status of the whole system. If combined with --all, follows that with the status of all units. If positional arguments are specified, each positional argument is treated as either a unit name to show, or a glob pattern to show units whose names match that pattern, or a PID to show the unit containing that PID. When --type=, --state=, or --failed are used, units are additionally filtered by the TYPE and ACTIVE state. This function is intended to generate human-readable output. If you are looking for computer-parsable output, use show instead. By default, this function only shows 10 lines of output and ellipsizes lines to fit in the terminal window. This can be changed with --lines and --full, see above. In addition, journalctl --unit=NAME or journalctl --user-unit=NAME use a similar filter for messages and might be more convenient. Note that this operation only displays runtime status, i.e. information about the current invocation of the unit (if it is running) or the most recent invocation (if it is not running anymore, and has not been released from memory). Information about earlier invocations, invocations from previous system boots, or prior invocations that have already been released from memory may be retrieved via journalctl --unit=. systemd implicitly loads units as necessary, so just running the status will attempt to load a file. The command is thus not useful for determining if something was already loaded or not. The units may possibly also be quickly unloaded after the operation is completed if there's no reason to keep it in memory thereafter. Example 1. Example output from systemctl status $ systemctl status bluetooth ● bluetooth.service - Bluetooth service Loaded: loaded (/usr/lib/systemd/system/bluetooth.service; enabled; preset: enabled) Active: active (running) since Wed 2017-01-04 13:54:04 EST; 1 weeks 0 days ago Docs: man:bluetoothd(8) Main PID: 930 (bluetoothd) Status: "Running" Tasks: 1 Memory: 648.0K CPU: 435ms CGroup: /system.slice/bluetooth.service └─930 /usr/lib/bluetooth/bluetoothd Jan 12 10:46:45 example.com bluetoothd[8900]: Not enough free handles to register service Jan 12 10:46:45 example.com bluetoothd[8900]: Current Time Service could not be registered Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output error (5) The dot ("●") uses color on supported terminals to summarize the unit state at a glance. Along with its color, its shape varies according to its state: "inactive" or "maintenance" is a white circle ("○"), "active" is a green dot ("●"), "deactivating" is a white dot, "failed" or "error" is a red cross ("×"), and "reloading" is a green clockwise circle arrow ("↻"). The "Loaded:" line in the output will show "loaded" if the unit has been loaded into memory. Other possible values for "Loaded:" include: "error" if there was a problem loading it, "not-found" if no unit file was found for this unit, "bad-setting" if an essential unit file setting could not be parsed and "masked" if the unit file has been masked. Along with showing the path to the unit file, this line will also show the enablement state. Enabled units are included in the dependency network between units, and thus are started at boot or via some other form of activation. See the full table of possible enablement states — including the definition of "masked" — in the documentation for the is-enabled command. The "Active:" line shows active state. The value is usually "active" or "inactive". Active could mean started, bound, plugged in, etc depending on the unit type. The unit could also be in process of changing states, reporting a state of "activating" or "deactivating". A special "failed" state is entered when the service failed in some way, such as a crash, exiting with an error code or timing out. If the failed state is entered the cause will be logged for later reference. show [PATTERN...|JOB...] Show properties of one or more units, jobs, or the manager itself. If no argument is specified, properties of the manager will be shown. If a unit name is specified, properties of the unit are shown, and if a job ID is specified, properties of the job are shown. By default, empty properties are suppressed. Use --all to show those too. To select specific properties to show, use --property=. This command is intended to be used whenever computer-parsable output is required. Use status if you are looking for formatted human-readable output. Many properties shown by systemctl show map directly to configuration settings of the system and service manager and its unit files. Note that the properties shown by the command are generally more low-level, normalized versions of the original configuration settings and expose runtime state in addition to configuration. For example, properties shown for service units include the service's current main process identifier as "MainPID" (which is runtime state), and time settings are always exposed as properties ending in the "...USec" suffix even if a matching configuration options end in "...Sec", because microseconds is the normalized time unit used internally by the system and service manager. For details about many of these properties, see the documentation of the D-Bus interface backing these properties, see org.freedesktop.systemd1(5). cat PATTERN... Show backing files of one or more units. Prints the "fragment" and "drop-ins" (source files) of units. Each file is preceded by a comment which includes the file name. Note that this shows the contents of the backing files on disk, which may not match the system manager's understanding of these units if any unit files were updated on disk and the daemon-reload command wasn't issued since. Added in version 209. help PATTERN...|PID... Show manual pages for one or more units, if available. If a PID is given, the manual pages for the unit the process belongs to are shown. Added in version 185. list-dependencies [UNIT...] Shows units required and wanted by the specified units. This recursively lists units following the Requires=, Requisite=, Wants=, ConsistsOf=, BindsTo=, and Upholds= dependencies. If no units are specified, default.target is implied. The units that are shown are additionally filtered by --type= and --state= if those options are specified. Note that we won't be able to use a tree structure in this case, so --plain is implied. By default, only target units are recursively expanded. When --all is passed, all other units are recursively expanded as well. Options --reverse, --after, --before may be used to change what types of dependencies are shown. Note that this command only lists units currently loaded into memory by the service manager. In particular, this command is not suitable to get a comprehensive list at all reverse dependencies on a specific unit, as it won't list the dependencies declared by units currently not loaded. Added in version 198. start PATTERN... Start (activate) one or more units specified on the command line. Note that unit glob patterns expand to names of units currently in memory. Units which are not active and are not in a failed state usually are not in memory, and will not be matched by any pattern. In addition, in case of instantiated units, systemd is often unaware of the instance name until the instance has been started. Therefore, using glob patterns with start has limited usefulness. Also, secondary alias names of units are not considered. Option --all may be used to also operate on inactive units which are referenced by other loaded units. Note that this is not the same as operating on "all" possible units, because as the previous paragraph describes, such a list is ill-defined. Nevertheless, systemctl start --all GLOB may be useful if all the units that should match the pattern are pulled in by some target which is known to be loaded. stop PATTERN... Stop (deactivate) one or more units specified on the command line. This command will fail if the unit does not exist or if stopping of the unit is prohibited (see RefuseManualStop= in systemd.unit(5)). It will not fail if any of the commands configured to stop the unit (ExecStop=, etc.) fail, because the manager will still forcibly terminate the unit. If a unit that gets stopped can still be triggered by other units, a warning containing the names of the triggering units is shown. --no-warn can be used to suppress the warning. reload PATTERN... Asks all units listed on the command line to reload their configuration. Note that this will reload the service-specific configuration, not the unit configuration file of systemd. If you want systemd to reload the configuration file of a unit, use the daemon-reload command. In other words: for the example case of Apache, this will reload Apache's httpd.conf in the web server, not the apache.service systemd unit file. This command should not be confused with the daemon-reload command. restart PATTERN... Stop and then start one or more units specified on the command line. If the units are not running yet, they will be started. Note that restarting a unit with this command does not necessarily flush out all of the unit's resources before it is started again. For example, the per-service file descriptor storage facility (see FileDescriptorStoreMax= in systemd.service(5)) will remain intact as long as the unit has a job pending, and is only cleared when the unit is fully stopped and no jobs are pending anymore. If it is intended that the file descriptor store is flushed out, too, during a restart operation an explicit systemctl stop command followed by systemctl start should be issued. try-restart PATTERN... Stop and then start one or more units specified on the command line if the units are running. This does nothing if units are not running. reload-or-restart PATTERN... Reload one or more units if they support it. If not, stop and then start them instead. If the units are not running yet, they will be started. try-reload-or-restart PATTERN... Reload one or more units if they support it. If not, stop and then start them instead. This does nothing if the units are not running. Added in version 229. isolate UNIT Start the unit specified on the command line and its dependencies and stop all others, unless they have IgnoreOnIsolate=yes (see systemd.unit(5)). If a unit name with no extension is given, an extension of ".target" will be assumed. This command is dangerous, since it will immediately stop processes that are not enabled in the new target, possibly including the graphical environment or terminal you are currently using. Note that this operation is allowed only on units where AllowIsolate= is enabled. See systemd.unit(5) for details. kill PATTERN... Send a UNIX process signal to one or more processes of the unit. Use --kill-whom= to select which process to send the signal to. Use --signal= to select the signal to send. Combine with --kill-value= to enqueue a POSIX Realtime Signal with an associated value. clean PATTERN... Remove the configuration, state, cache, logs or runtime data of the specified units. Use --what= to select which kind of resource to remove. For service units this may be used to remove the directories configured with ConfigurationDirectory=, StateDirectory=, CacheDirectory=, LogsDirectory= and RuntimeDirectory=, see systemd.exec(5) for details. It may also be used to clear the file descriptor store as enabled via FileDescriptorStoreMax=, see systemd.service(5) for details. For timer units this may be used to clear out the persistent timestamp data if Persistent= is used and --what=state is selected, see systemd.timer(5). This command only applies to units that use either of these settings. If --what= is not specified, the cache and runtime data as well as the file descriptor store are removed (as these three types of resources are generally redundant and reproducible on the next invocation of the unit). Note that the specified units must be stopped to invoke this operation. Added in version 243. freeze PATTERN... Freeze one or more units specified on the command line using cgroup freezer Freezing the unit will cause all processes contained within the cgroup corresponding to the unit to be suspended. Being suspended means that unit's processes won't be scheduled to run on CPU until thawed. Note that this command is supported only on systems that use unified cgroup hierarchy. Unit is automatically thawed just before we execute a job against the unit, e.g. before the unit is stopped. Added in version 246. thaw PATTERN... Thaw (unfreeze) one or more units specified on the command line. This is the inverse operation to the freeze command and resumes the execution of processes in the unit's cgroup. Added in version 246. set-property UNIT PROPERTY=VALUE... Set the specified unit properties at runtime where this is supported. This allows changing configuration parameter properties such as resource control settings at runtime. Not all properties may be changed at runtime, but many resource control settings (primarily those in systemd.resource-control(5)) may. The changes are applied immediately, and stored on disk for future boots, unless --runtime is passed, in which case the settings only apply until the next reboot. The syntax of the property assignment follows closely the syntax of assignments in unit files. Example: systemctl set-property foobar.service CPUWeight=200 If the specified unit appears to be inactive, the changes will be only stored on disk as described previously hence they will be effective when the unit will be started. Note that this command allows changing multiple properties at the same time, which is preferable over setting them individually. Example: systemctl set-property foobar.service CPUWeight=200 MemoryMax=2G IPAccounting=yes Like with unit file configuration settings, assigning an empty setting usually resets a property to its defaults. Example: systemctl set-property avahi-daemon.service IPAddressDeny= Added in version 206. bind UNIT PATH [PATH] Bind-mounts a file or directory from the host into the specified unit's mount namespace. The first path argument is the source file or directory on the host, the second path argument is the destination file or directory in the unit's mount namespace. When the latter is omitted, the destination path in the unit's mount namespace is the same as the source path on the host. When combined with the --read-only switch, a ready-only bind mount is created. When combined with the --mkdir switch, the destination path is first created before the mount is applied. Note that this option is currently only supported for units that run within a mount namespace (e.g.: with RootImage=, PrivateMounts=, etc.). This command supports bind-mounting directories, regular files, device nodes, AF_UNIX socket nodes, as well as FIFOs. The bind mount is ephemeral, and it is undone as soon as the current unit process exists. Note that the namespace mentioned here, where the bind mount will be added to, is the one where the main service process runs. Other processes (those exececuted by ExecReload=, ExecStartPre=, etc.) run in distinct namespaces. If supported by the kernel, any prior mount on the selected target will be replaced by the new mount. If not supported, any prior mount will be over-mounted, but remain pinned and inaccessible. Added in version 248. mount-image UNIT IMAGE [PATH [PARTITION_NAME:MOUNT_OPTIONS]] Mounts an image from the host into the specified unit's mount namespace. The first path argument is the source image on the host, the second path argument is the destination directory in the unit's mount namespace (i.e. inside RootImage=/RootDirectory=). The following argument, if any, is interpreted as a colon-separated tuple of partition name and comma-separated list of mount options for that partition. The format is the same as the service MountImages= setting. When combined with the --read-only switch, a ready-only mount is created. When combined with the --mkdir switch, the destination path is first created before the mount is applied. Note that this option is currently only supported for units that run within a mount namespace (i.e. with RootImage=, PrivateMounts=, etc.). Note that the namespace mentioned here where the image mount will be added to, is the one where the main service process runs. Note that the namespace mentioned here, where the bind mount will be added to, is the one where the main service process runs. Other processes (those exececuted by ExecReload=, ExecStartPre=, etc.) run in distinct namespaces. If supported by the kernel, any prior mount on the selected target will be replaced by the new mount. If not supported, any prior mount will be over-mounted, but remain pinned and inaccessible. Example: systemctl mount-image foo.service /tmp/img.raw /var/lib/image root:ro,nosuid systemctl mount-image --mkdir bar.service /tmp/img.raw /var/lib/baz/img Added in version 248. service-log-level SERVICE [LEVEL] If the LEVEL argument is not given, print the current log level as reported by service SERVICE. If the optional argument LEVEL is provided, then change the current log level of the service to LEVEL. The log level should be a typical syslog log level, i.e. a value in the range 0...7 or one of the strings emerg, alert, crit, err, warning, notice, info, debug; see syslog(3) for details. The service must have the appropriate BusName=destination property and also implement the generic org.freedesktop.LogControl1(5) interface. (systemctl will use the generic D-Bus protocol to access the org.freedesktop.LogControl1.LogLevel interface for the D-Bus name destination.) Added in version 247. service-log-target SERVICE [TARGET] If the TARGET argument is not given, print the current log target as reported by service SERVICE. If the optional argument TARGET is provided, then change the current log target of the service to TARGET. The log target should be one of the strings console (for log output to the service's standard error stream), kmsg (for log output to the kernel log buffer), journal (for log output to systemd-journald.service(8) using the native journal protocol), syslog (for log output to the classic syslog socket /dev/log), null (for no log output whatsoever) or auto (for an automatically determined choice, typically equivalent to console if the service is invoked interactively, and journal or syslog otherwise). For most services, only a small subset of log targets make sense. In particular, most "normal" services should only implement console, journal, and null. Anything else is only appropriate for low-level services that are active in very early boot before proper logging is established. The service must have the appropriate BusName=destination property and also implement the generic org.freedesktop.LogControl1(5) interface. (systemctl will use the generic D-Bus protocol to access the org.freedesktop.LogControl1.LogLevel interface for the D-Bus name destination.) Added in version 247. reset-failed [PATTERN...] Reset the "failed" state of the specified units, or if no unit name is passed, reset the state of all units. When a unit fails in some way (i.e. process exiting with non-zero error code, terminating abnormally or timing out), it will automatically enter the "failed" state and its exit code and status is recorded for introspection by the administrator until the service is stopped/re-started or reset with this command. In addition to resetting the "failed" state of a unit it also resets various other per-unit properties: the start rate limit counter of all unit types is reset to zero, as is the restart counter of service units. Thus, if a unit's start limit (as configured with StartLimitIntervalSec=/StartLimitBurst=) is hit and the unit refuses to be started again, use this command to make it startable again. whoami [PID...] Returns the units the processes referenced by the given PIDs belong to (one per line). If no PID is specified returns the unit the systemctl command is invoked in. Added in version 254. Unit File Commands list-unit-files [PATTERN...] List unit files installed on the system, in combination with their enablement state (as reported by is-enabled). If one or more PATTERNs are specified, only unit files whose name matches one of them are shown (patterns matching unit file system paths are not supported). Unlike list-units this command will list template units in addition to explicitly instantiated units. Added in version 233. enable UNIT..., enable PATH... Enable one or more units or unit instances. This will create a set of symlinks, as encoded in the [Install] sections of the indicated unit files. After the symlinks have been created, the system manager configuration is reloaded (in a way equivalent to daemon-reload), in order to ensure the changes are taken into account immediately. Note that this does not have the effect of also starting any of the units being enabled. If this is desired, combine this command with the --now switch, or invoke start with appropriate arguments later. Note that in case of unit instance enablement (i.e. enablement of units of the form [email protected]), symlinks named the same as instances are created in the unit configuration directory, however they point to the single template unit file they are instantiated from. This command expects either valid unit names (in which case various unit file directories are automatically searched for unit files with appropriate names), or absolute paths to unit files (in which case these files are read directly). If a specified unit file is located outside of the usual unit file directories, an additional symlink is created, linking it into the unit configuration path, thus ensuring it is found when requested by commands such as start. The file system where the linked unit files are located must be accessible when systemd is started (e.g. anything underneath /home/ or /var/ is not allowed, unless those directories are located on the root file system). This command will print the file system operations executed. This output may be suppressed by passing --quiet. Note that this operation creates only the symlinks suggested in the [Install] section of the unit files. While this command is the recommended way to manipulate the unit configuration directory, the administrator is free to make additional changes manually by placing or removing symlinks below this directory. This is particularly useful to create configurations that deviate from the suggested default installation. In this case, the administrator must make sure to invoke daemon-reload manually as necessary, in order to ensure the changes are taken into account. When using this operation on units without install information, a warning about it is shown. --no-warn can be used to suppress the warning. Enabling units should not be confused with starting (activating) units, as done by the start command. Enabling and starting units is orthogonal: units may be enabled without being started and started without being enabled. Enabling simply hooks the unit into various suggested places (for example, so that the unit is automatically started on boot or when a particular kind of hardware is plugged in). Starting actually spawns the daemon process (in case of service units), or binds the socket (in case of socket units), and so on. Depending on whether --system, --user, --runtime, or --global is specified, this enables the unit for the system, for the calling user only, for only this boot of the system, or for all future logins of all users. Note that in the last case, no systemd daemon configuration is reloaded. Using enable on masked units is not supported and results in an error. disable UNIT... Disables one or more units. This removes all symlinks to the unit files backing the specified units from the unit configuration directory, and hence undoes any changes made by enable or link. Note that this removes all symlinks to matching unit files, including manually created symlinks, and not just those actually created by enable or link. Note that while disable undoes the effect of enable, the two commands are otherwise not symmetric, as disable may remove more symlinks than a prior enable invocation of the same unit created. This command expects valid unit names only, it does not accept paths to unit files. In addition to the units specified as arguments, all units are disabled that are listed in the Also= setting contained in the [Install] section of any of the unit files being operated on. This command implicitly reloads the system manager configuration after completing the operation. Note that this command does not implicitly stop the units that are being disabled. If this is desired, either combine this command with the --now switch, or invoke the stop command with appropriate arguments later. This command will print information about the file system operations (symlink removals) executed. This output may be suppressed by passing --quiet. If a unit gets disabled but its triggering units are still active, a warning containing the names of the triggering units is shown. --no-warn can be used to suppress the warning. When this command is used with --user, the units being operated on might still be enabled in global scope, and thus get started automatically even after a successful disablement in user scope. In this case, a warning about it is shown, which can be suppressed using --no-warn. This command honors --system, --user, --runtime, --global and --no-warn in a similar way as enable. Added in version 238. reenable UNIT... Reenable one or more units, as specified on the command line. This is a combination of disable and enable and is useful to reset the symlinks a unit file is enabled with to the defaults configured in its [Install] section. This command expects a unit name only, it does not accept paths to unit files. Added in version 238. preset UNIT... Reset the enable/disable status one or more unit files, as specified on the command line, to the defaults configured in the preset policy files. This has the same effect as disable or enable, depending how the unit is listed in the preset files. Use --preset-mode= to control whether units shall be enabled and disabled, or only enabled, or only disabled. If the unit carries no install information, it will be silently ignored by this command. UNIT must be the real unit name, any alias names are ignored silently. For more information on the preset policy format, see systemd.preset(5). Added in version 238. preset-all Resets all installed unit files to the defaults configured in the preset policy file (see above). Use --preset-mode= to control whether units shall be enabled and disabled, or only enabled, or only disabled. Added in version 215. is-enabled UNIT... Checks whether any of the specified unit files are enabled (as with enable). Returns an exit code of 0 if at least one is enabled, non-zero otherwise. Prints the current enable status (see table). To suppress this output, use --quiet. To show installation targets, use --full. Table 1. is-enabled output ┌───────────────────┬─────────────────────────────────────────┬───────────┐ │ Name │ Description │ Exit Code │ ├───────────────────┼─────────────────────────────────────────┼───────────┤ │ "enabled" │ Enabled via .wants/, .requires/ or │ │ ├───────────────────┤ Alias= symlinks (permanently in │ 0 │ │ "enabled-runtime" │ /etc/systemd/system/, or transiently in │ │ │ │ /run/systemd/system/). │ │ ├───────────────────┼─────────────────────────────────────────┼───────────┤ │ "linked" │ Made available through one or more │ │ ├───────────────────┤ symlinks to the unit file (permanently │ │ │ "linked-runtime" │ in /etc/systemd/system/ or transiently │ > 0 │ │ │ in /run/systemd/system/), even though │ │ │ │ the unit file might reside outside of │ │ │ │ the unit file search path. │ │ ├───────────────────┼─────────────────────────────────────────┼───────────┤ │ "alias" │ The name is an alias (symlink to │ 0 │ │ │ another unit file). │ │ ├───────────────────┼─────────────────────────────────────────┼───────────┤ │ "masked" │ Completely disabled, so that any start │ │ ├───────────────────┤ operation on it fails (permanently in │ > 0 │ │ "masked-runtime" │ /etc/systemd/system/ or transiently in │ │ │ │ /run/systemd/systemd/). │ │ ├───────────────────┼─────────────────────────────────────────┼───────────┤ │ "static" │ The unit file is not enabled, and has │ 0 │ │ │ no provisions for enabling in the │ │ │ │ [Install] unit file section. │ │ ├───────────────────┼─────────────────────────────────────────┼───────────┤ │ "indirect" │ The unit file itself is not enabled, │ 0 │ │ │ but it has a non-empty Also= setting in │ │ │ │ the [Install] unit file section, │ │ │ │ listing other unit files that might be │ │ │ │ enabled, or it has an alias under a │ │ │ │ different name through a symlink that │ │ │ │ is not specified in Also=. For template │ │ │ │ unit files, an instance different than │ │ │ │ the one specified in DefaultInstance= │ │ │ │ is enabled. │ │ ├───────────────────┼─────────────────────────────────────────┼───────────┤ │ "disabled" │ The unit file is not enabled, but │ > 0 │ │ │ contains an [Install] section with │ │ │ │ installation instructions. │ │ ├───────────────────┼─────────────────────────────────────────┼───────────┤ │ "generated" │ The unit file was generated dynamically │ 0 │ │ │ via a generator tool. See │ │ │ │ systemd.generator(7). Generated unit │ │ │ │ files may not be enabled, they are │ │ │ │ enabled implicitly by their generator. │ │ ├───────────────────┼─────────────────────────────────────────┼───────────┤ │ "transient" │ The unit file has been created │ 0 │ │ │ dynamically with the runtime API. │ │ │ │ Transient units may not be enabled. │ │ ├───────────────────┼─────────────────────────────────────────┼───────────┤ │ "bad" │ The unit file is invalid or another │ > 0 │ │ │ error occurred. Note that is-enabled │ │ │ │ will not actually return this state, │ │ │ │ but print an error message instead. │ │ │ │ However the unit file listing printed │ │ │ │ by list-unit-files might show it. │ │ ├───────────────────┼─────────────────────────────────────────┼───────────┤ │ "not-found" │ The unit file doesn't exist. │ 4 │ └───────────────────┴─────────────────────────────────────────┴───────────┘ Added in version 238. mask UNIT... Mask one or more units, as specified on the command line. This will link these unit files to /dev/null, making it impossible to start them. This is a stronger version of disable, since it prohibits all kinds of activation of the unit, including enablement and manual activation. Use this option with care. This honors the --runtime option to only mask temporarily until the next reboot of the system. The --now option may be used to ensure that the units are also stopped. This command expects valid unit names only, it does not accept unit file paths. Note that this will create a symlink under the unit's name in /etc/systemd/system/ (in case --runtime is not specified) or /run/systemd/system/ (in case --runtime is specified). If a matching unit file already exists under these directories this operation will hence fail. This means that the operation is primarily useful to mask units shipped by the vendor (as those are shipped in /usr/lib/systemd/system/ and not the aforementioned two directories), but typically doesn't work for units created locally (as those are typically placed precisely in the two aforementioned directories). Similar restrictions apply for --user mode, in which case the directories are below the user's home directory however. If a unit gets masked but its triggering units are still active, a warning containing the names of the triggering units is shown. --no-warn can be used to suppress the warning. Added in version 238. unmask UNIT... Unmask one or more unit files, as specified on the command line. This will undo the effect of mask. This command expects valid unit names only, it does not accept unit file paths. Added in version 238. link PATH... Link a unit file that is not in the unit file search path into the unit file search path. This command expects an absolute path to a unit file. The effect of this may be undone with disable. The effect of this command is that a unit file is made available for commands such as start, even though it is not installed directly in the unit search path. The file system where the linked unit files are located must be accessible when systemd is started (e.g. anything underneath /home/ or /var/ is not allowed, unless those directories are located on the root file system). Added in version 233. revert UNIT... Revert one or more unit files to their vendor versions. This command removes drop-in configuration files that modify the specified units, as well as any user-configured unit file that overrides a matching vendor supplied unit file. Specifically, for a unit "foo.service" the matching directories "foo.service.d/" with all their contained files are removed, both below the persistent and runtime configuration directories (i.e. below /etc/systemd/system and /run/systemd/system); if the unit file has a vendor-supplied version (i.e. a unit file located below /usr/) any matching persistent or runtime unit file that overrides it is removed, too. Note that if a unit file has no vendor-supplied version (i.e. is only defined below /etc/systemd/system or /run/systemd/system, but not in a unit file stored below /usr/), then it is not removed. Also, if a unit is masked, it is unmasked. Effectively, this command may be used to undo all changes made with systemctl edit, systemctl set-property and systemctl mask and puts the original unit file with its settings back in effect. Added in version 230. add-wants TARGET UNIT..., add-requires TARGET UNIT... Adds "Wants=" or "Requires=" dependencies, respectively, to the specified TARGET for one or more units. This command honors --system, --user, --runtime and --global in a way similar to enable. Added in version 217. edit UNIT... Edit a drop-in snippet or a whole replacement file if --full is specified, to extend or override the specified unit. Depending on whether --system (the default), --user, or --global is specified, this command creates a drop-in file for each unit either for the system, for the calling user, or for all futures logins of all users. Then, the editor (see the "Environment" section below) is invoked on temporary files which will be written to the real location if the editor exits successfully. If --drop-in= is specified, the given drop-in file name will be used instead of the default override.conf. If --full is specified, this will copy the original units instead of creating drop-in files. If --force is specified and any units do not already exist, new unit files will be opened for editing. If --runtime is specified, the changes will be made temporarily in /run/ and they will be lost on the next reboot. If the temporary file is empty upon exit, the modification of the related unit is canceled. After the units have been edited, systemd configuration is reloaded (in a way that is equivalent to daemon-reload). Note that this command cannot be used to remotely edit units and that you cannot temporarily edit units which are in /etc/, since they take precedence over /run/. Added in version 218. get-default Return the default target to boot into. This returns the target unit name default.target is aliased (symlinked) to. Added in version 205. set-default TARGET Set the default target to boot into. This sets (symlinks) the default.target alias to the given target unit. Added in version 205. Machine Commands list-machines [PATTERN...] List the host and all running local containers with their state. If one or more PATTERNs are specified, only containers matching one of them are shown. Added in version 212. Job Commands list-jobs [PATTERN...] List jobs that are in progress. If one or more PATTERNs are specified, only jobs for units matching one of them are shown. When combined with --after or --before the list is augmented with information on which other job each job is waiting for, and which other jobs are waiting for it, see above. Added in version 233. cancel [JOB...] Cancel one or more jobs specified on the command line by their numeric job IDs. If no job ID is specified, cancel all pending jobs. Added in version 233. Environment Commands systemd supports an environment block that is passed to processes the manager spawns. The names of the variables can contain ASCII letters, digits, and the underscore character. Variable names cannot be empty or start with a digit. In variable values, most characters are allowed, but the whole sequence must be valid UTF-8. (Note that control characters like newline (NL), tab (TAB), or the escape character (ESC), are valid ASCII and thus valid UTF-8). The total length of the environment block is limited to _SC_ARG_MAX value defined by sysconf(3). show-environment Dump the systemd manager environment block. This is the environment block that is passed to all processes the manager spawns. The environment block will be dumped in straightforward form suitable for sourcing into most shells. If no special characters or whitespace is present in the variable values, no escaping is performed, and the assignments have the form "VARIABLE=value". If whitespace or characters which have special meaning to the shell are present, dollar-single-quote escaping is used, and assignments have the form "VARIABLE=$'value'". This syntax is known to be supported by bash(1), zsh(1), ksh(1), and busybox(1)'s ash(1), but not dash(1) or fish(1). set-environment VARIABLE=VALUE... Set one or more systemd manager environment variables, as specified on the command line. This command will fail if variable names and values do not conform to the rules listed above. Added in version 233. unset-environment VARIABLE... Unset one or more systemd manager environment variables. If only a variable name is specified, it will be removed regardless of its value. If a variable and a value are specified, the variable is only removed if it has the specified value. Added in version 233. import-environment VARIABLE... Import all, one or more environment variables set on the client into the systemd manager environment block. If a list of environment variable names is passed, client-side values are then imported into the manager's environment block. If any names are not valid environment variable names or have invalid values according to the rules described above, an error is raised. If no arguments are passed, the entire environment block inherited by the systemctl process is imported. In this mode, any inherited invalid environment variables are quietly ignored. Importing of the full inherited environment block (calling this command without any arguments) is deprecated. A shell will set dozens of variables which only make sense locally and are only meant for processes which are descendants of the shell. Such variables in the global environment block are confusing to other processes. Added in version 209. Manager State Commands daemon-reload Reload the systemd manager configuration. This will rerun all generators (see systemd.generator(7)), reload all unit files, and recreate the entire dependency tree. While the daemon is being reloaded, all sockets systemd listens on behalf of user configuration will stay accessible. This command should not be confused with the reload command. daemon-reexec Reexecute the systemd manager. This will serialize the manager state, reexecute the process and deserialize the state again. This command is of little use except for debugging and package upgrades. Sometimes, it might be helpful as a heavy-weight daemon-reload. While the daemon is being reexecuted, all sockets systemd listening on behalf of user configuration will stay accessible. log-level [LEVEL] If no argument is given, print the current log level of the manager. If an optional argument LEVEL is provided, then the command changes the current log level of the manager to LEVEL (accepts the same values as --log-level= described in systemd(1)). Added in version 244. log-target [TARGET] If no argument is given, print the current log target of the manager. If an optional argument TARGET is provided, then the command changes the current log target of the manager to TARGET (accepts the same values as --log-target=, described in systemd(1)). Added in version 244. service-watchdogs [yes|no] If no argument is given, print the current state of service runtime watchdogs of the manager. If an optional boolean argument is provided, then globally enables or disables the service runtime watchdogs (WatchdogSec=) and emergency actions (e.g. OnFailure= or StartLimitAction=); see systemd.service(5). The hardware watchdog is not affected by this setting. Added in version 244. System Commands is-system-running Checks whether the system is operational. This returns success (exit code 0) when the system is fully up and running, specifically not in startup, shutdown or maintenance mode, and with no failed services. Failure is returned otherwise (exit code non-zero). In addition, the current state is printed in a short string to standard output, see the table below. Use --quiet to suppress this output. Use --wait to wait until the boot process is completed before printing the current state and returning the appropriate error status. If --wait is in use, states initializing or starting will not be reported, instead the command will block until a later state (such as running or degraded) is reached. Table 2. is-system-running output ┌──────────────┬─────────────────────────────────────────┬───────────┐ │ Name │ Description │ Exit Code │ ├──────────────┼─────────────────────────────────────────┼───────────┤ │ initializing │ Early bootup, before basic.target is │ > 0 │ │ │ reached or the maintenance state │ │ │ │ entered. │ │ ├──────────────┼─────────────────────────────────────────┼───────────┤ │ starting │ Late bootup, before the job queue │ > 0 │ │ │ becomes idle for the first time, or one │ │ │ │ of the rescue targets are reached. │ │ ├──────────────┼─────────────────────────────────────────┼───────────┤ │ running │ The system is fully operational. │ 0 │ ├──────────────┼─────────────────────────────────────────┼───────────┤ │ degraded │ The system is operational but one or │ > 0 │ │ │ more units failed. │ │ ├──────────────┼─────────────────────────────────────────┼───────────┤ │ maintenance │ The rescue or emergency target is │ > 0 │ │ │ active. │ │ ├──────────────┼─────────────────────────────────────────┼───────────┤ │ stopping │ The manager is shutting down. │ > 0 │ ├──────────────┼─────────────────────────────────────────┼───────────┤ │ offline │ The manager is not running. │ > 0 │ │ │ Specifically, this is the operational │ │ │ │ state if an incompatible program is │ │ │ │ running as system manager (PID 1). │ │ ├──────────────┼─────────────────────────────────────────┼───────────┤ │ unknown │ The operational state could not be │ > 0 │ │ │ determined, due to lack of resources or │ │ │ │ another error cause. │ │ └──────────────┴─────────────────────────────────────────┴───────────┘ Added in version 215. default Enter default mode. This is equivalent to systemctl isolate default.target. This operation is blocking by default, use --no-block to request asynchronous behavior. rescue Enter rescue mode. This is equivalent to systemctl isolate rescue.target. This operation is blocking by default, use --no-block to request asynchronous behavior. emergency Enter emergency mode. This is equivalent to systemctl isolate emergency.target. This operation is blocking by default, use --no-block to request asynchronous behavior. halt Shut down and halt the system. This is mostly equivalent to systemctl start halt.target --job-mode=replace-irreversibly --no-block, but also prints a wall message to all users. This command is asynchronous; it will return after the halt operation is enqueued, without waiting for it to complete. Note that this operation will simply halt the OS kernel after shutting down, leaving the hardware powered on. Use systemctl poweroff for powering off the system (see below). If combined with --force, shutdown of all running services is skipped, however all processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the system halt. If --force is specified twice, the operation is immediately executed without terminating any processes or unmounting any file systems. This may result in data loss. Note that when --force is specified twice the halt operation is executed by systemctl itself, and the system manager is not contacted. This means the command should succeed even when the system manager has crashed. If combined with --when=, shutdown will be scheduled after the given timestamp. And --when=cancel will cancel the shutdown. poweroff Shut down and power-off the system. This is mostly equivalent to systemctl start poweroff.target --job-mode=replace-irreversibly --no-block, but also prints a wall message to all users. This command is asynchronous; it will return after the power-off operation is enqueued, without waiting for it to complete. This command honors --force and --when= in a similar way as halt. reboot Shut down and reboot the system. This command mostly equivalent to systemctl start reboot.target --job-mode=replace-irreversibly --no-block, but also prints a wall message to all users. This command is asynchronous; it will return after the reboot operation is enqueued, without waiting for it to complete. If the switch --reboot-argument= is given, it will be passed as the optional argument to the reboot(2) system call. Options --boot-loader-entry=, --boot-loader-menu=, and --firmware-setup can be used to select what to do after the reboot. See the descriptions of those options for details. This command honors --force and --when= in a similar way as halt. If a new kernel has been loaded via kexec --load, a kexec will be performed instead of a reboot, unless "SYSTEMCTL_SKIP_AUTO_KEXEC=1" has been set. If a new root file system has been set up on "/run/nextroot/", a soft-reboot will be performed instead of a reboot, unless "SYSTEMCTL_SKIP_AUTO_SOFT_REBOOT=1" has been set. Added in version 246. kexec Shut down and reboot the system via kexec. This command will load a kexec kernel if one wasn't loaded yet or fail. A kernel may be loaded earlier by a separate step, this is particularly useful if a custom initrd or additional kernel command line options are desired. The --force can be used to continue without a kexec kernel, i.e. to perform a normal reboot. The final reboot step is equivalent to systemctl start kexec.target --job-mode=replace-irreversibly --no-block. To load a kernel, an enumeration is performed following the Boot Loader Specification[1], and the default boot entry is loaded. For this step to succeed, the system must be using UEFI and the boot loader entries must be configured appropriately. bootctl list may be used to list boot entries, see bootctl(1). This command is asynchronous; it will return after the reboot operation is enqueued, without waiting for it to complete. This command honors --force and --when= similarly to halt. If a new kernel has been loaded via kexec --load, a kexec will be performed when reboot is invoked, unless "SYSTEMCTL_SKIP_AUTO_KEXEC=1" has been set. soft-reboot Shut down and reboot userspace. This is equivalent to systemctl start soft-reboot.target --job-mode=replace-irreversibly --no-block. This command is asynchronous; it will return after the reboot operation is enqueued, without waiting for it to complete. This command honors --force and --when= in a similar way as halt. This operation only reboots userspace, leaving the kernel running. See systemd-soft-reboot.service(8) for details. If a new root file system has been set up on "/run/nextroot/", a soft-reboot will be performed when reboot is invoked, unless "SYSTEMCTL_SKIP_AUTO_SOFT_REBOOT=1" has been set. Added in version 254. exit [EXIT_CODE] Ask the service manager to quit. This is only supported for user service managers (i.e. in conjunction with the --user option) or in containers and is equivalent to poweroff otherwise. This command is asynchronous; it will return after the exit operation is enqueued, without waiting for it to complete. The service manager will exit with the specified exit code, if EXIT_CODE is passed. Added in version 227. switch-root [ROOT [INIT]] Switches to a different root directory and executes a new system manager process below it. This is intended for use in the initrd, and will transition from the initrd's system manager process (a.k.a. "init" process, PID 1) to the main system manager process which is loaded from the actual host root files system. This call takes two arguments: the directory that is to become the new root directory, and the path to the new system manager binary below it to execute as PID 1. If both are omitted or the former is an empty string it defaults to /sysroot/. If the latter is omitted or is an empty string, a systemd binary will automatically be searched for and used as service manager. If the system manager path is omitted, equal to the empty string or identical to the path to the systemd binary, the state of the initrd's system manager process is passed to the main system manager, which allows later introspection of the state of the services involved in the initrd boot phase. Added in version 209. suspend Suspend the system. This will trigger activation of the special target unit suspend.target. This command is asynchronous, and will return after the suspend operation is successfully enqueued. It will not wait for the suspend/resume cycle to complete. hibernate Hibernate the system. This will trigger activation of the special target unit hibernate.target. This command is asynchronous, and will return after the hibernation operation is successfully enqueued. It will not wait for the hibernate/thaw cycle to complete. hybrid-sleep Hibernate and suspend the system. This will trigger activation of the special target unit hybrid-sleep.target. This command is asynchronous, and will return after the hybrid sleep operation is successfully enqueued. It will not wait for the sleep/wake-up cycle to complete. Added in version 196. suspend-then-hibernate Suspend the system and hibernate it after the delay specified in systemd-sleep.conf. This will trigger activation of the special target unit suspend-then-hibernate.target. This command is asynchronous, and will return after the hybrid sleep operation is successfully enqueued. It will not wait for the sleep/wake-up or hibernate/thaw cycle to complete. Added in version 240. Parameter Syntax Unit commands listed above take either a single unit name (designated as UNIT), or multiple unit specifications (designated as PATTERN...). In the first case, the unit name with or without a suffix must be given. If the suffix is not specified (unit name is "abbreviated"), systemctl will append a suitable suffix, ".service" by default, and a type-specific suffix in case of commands which operate only on specific unit types. For example, # systemctl start sshd and # systemctl start sshd.service are equivalent, as are # systemctl isolate default and # systemctl isolate default.target Note that (absolute) paths to device nodes are automatically converted to device unit names, and other (absolute) paths to mount unit names. # systemctl status /dev/sda # systemctl status /home are equivalent to: # systemctl status dev-sda.device # systemctl status home.mount In the second case, shell-style globs will be matched against the primary names of all units currently in memory; literal unit names, with or without a suffix, will be treated as in the first case. This means that literal unit names always refer to exactly one unit, but globs may match zero units and this is not considered an error. Glob patterns use fnmatch(3), so normal shell-style globbing rules are used, and "*", "?", "[]" may be used. See glob(7) for more details. The patterns are matched against the primary names of units currently in memory, and patterns which do not match anything are silently skipped. For example: # systemctl stop sshd@*.service will stop all [email protected] instances. Note that alias names of units, and units that aren't in memory are not considered for glob expansion. For unit file commands, the specified UNIT should be the name of the unit file (possibly abbreviated, see above), or the absolute path to the unit file: # systemctl enable foo.service or # systemctl link /path/to/foo.service OPTIONS The following options are understood: -t, --type= The argument is a comma-separated list of unit types such as service and socket. When units are listed with list-units, list-dependencies, show, or status, only units of the specified types will be shown. By default, units of all types are shown. As a special case, if one of the arguments is help, a list of allowed values will be printed and the program will exit. --state= The argument is a comma-separated list of unit LOAD, SUB, or ACTIVE states. When listing units with list-units, list-dependencies, show or status, show only those in the specified states. Use --state=failed or --failed to show only failed units. As a special case, if one of the arguments is help, a list of allowed values will be printed and the program will exit. Added in version 206. -p, --property= When showing unit/job/manager properties with the show command, limit display to properties specified in the argument. The argument should be a comma-separated list of property names, such as "MainPID". Unless specified, all known properties are shown. If specified more than once, all properties with the specified names are shown. Shell completion is implemented for property names. For the manager itself, systemctl show will show all available properties, most of which are derived or closely match the options described in systemd-system.conf(5). Properties for units vary by unit type, so showing any unit (even a non-existent one) is a way to list properties pertaining to this type. Similarly, showing any job will list properties pertaining to all jobs. Properties for units are documented in systemd.unit(5), and the pages for individual unit types systemd.service(5), systemd.socket(5), etc. -P Equivalent to --value --property=, i.e. shows the value of the property without the property name or "=". Note that using -P once will also affect all properties listed with -p/--property=. Added in version 246. -a, --all When listing units with list-units, also show inactive units and units which are following other units. When showing unit/job/manager properties, show all properties regardless whether they are set or not. To list all units installed in the file system, use the list-unit-files command instead. When listing units with list-dependencies, recursively show dependencies of all dependent units (by default only dependencies of target units are shown). When used with status, show journal messages in full, even if they include unprintable characters or are very long. By default, fields with unprintable characters are abbreviated as "blob data". (Note that the pager may escape unprintable characters again.) -r, --recursive When listing units, also show units of local containers. Units of local containers will be prefixed with the container name, separated by a single colon character (":"). Added in version 212. --reverse Show reverse dependencies between units with list-dependencies, i.e. follow dependencies of type WantedBy=, RequiredBy=, UpheldBy=, PartOf=, BoundBy=, instead of Wants= and similar. Added in version 203. --after With list-dependencies, show the units that are ordered before the specified unit. In other words, recursively list units following the After= dependency. Note that any After= dependency is automatically mirrored to create a Before= dependency. Temporal dependencies may be specified explicitly, but are also created implicitly for units which are WantedBy= targets (see systemd.target(5)), and as a result of other directives (for example RequiresMountsFor=). Both explicitly and implicitly introduced dependencies are shown with list-dependencies. When passed to the list-jobs command, for each printed job show which other jobs are waiting for it. May be combined with --before to show both the jobs waiting for each job as well as all jobs each job is waiting for. Added in version 203. --before With list-dependencies, show the units that are ordered after the specified unit. In other words, recursively list units following the Before= dependency. When passed to the list-jobs command, for each printed job show which other jobs it is waiting for. May be combined with --after to show both the jobs waiting for each job as well as all jobs each job is waiting for. Added in version 212. --with-dependencies When used with status, cat, list-units, and list-unit-files, those commands print all specified units and the dependencies of those units. Options --reverse, --after, --before may be used to change what types of dependencies are shown. Added in version 245. -l, --full Do not ellipsize unit names, process tree entries, journal output, or truncate unit descriptions in the output of status, list-units, list-jobs, and list-timers. Also, show installation targets in the output of is-enabled. --value When printing properties with show, only print the value, and skip the property name and "=". Also see option -P above. Added in version 230. --show-types When showing sockets, show the type of the socket. Added in version 202. --job-mode= When queuing a new job, this option controls how to deal with already queued jobs. It takes one of "fail", "replace", "replace-irreversibly", "isolate", "ignore-dependencies", "ignore-requirements", "flush", "triggering", or "restart-dependencies". Defaults to "replace", except when the isolate command is used which implies the "isolate" job mode. If "fail" is specified and a requested operation conflicts with a pending job (more specifically: causes an already pending start job to be reversed into a stop job or vice versa), cause the operation to fail. If "replace" (the default) is specified, any conflicting pending job will be replaced, as necessary. If "replace-irreversibly" is specified, operate like "replace", but also mark the new jobs as irreversible. This prevents future conflicting transactions from replacing these jobs (or even being enqueued while the irreversible jobs are still pending). Irreversible jobs can still be cancelled using the cancel command. This job mode should be used on any transaction which pulls in shutdown.target. "isolate" is only valid for start operations and causes all other units to be stopped when the specified unit is started. This mode is always used when the isolate command is used. "flush" will cause all queued jobs to be canceled when the new job is enqueued. If "ignore-dependencies" is specified, then all unit dependencies are ignored for this new job and the operation is executed immediately. If passed, no required units of the unit passed will be pulled in, and no ordering dependencies will be honored. This is mostly a debugging and rescue tool for the administrator and should not be used by applications. "ignore-requirements" is similar to "ignore-dependencies", but only causes the requirement dependencies to be ignored, the ordering dependencies will still be honored. "triggering" may only be used with systemctl stop. In this mode, the specified unit and any active units that trigger it are stopped. See the discussion of Triggers= in systemd.unit(5) for more information about triggering units. "restart-dependencies" may only be used with systemctl start. In this mode, dependencies of the specified unit will receive restart propagation, as if a restart job had been enqueued for the unit. Added in version 209. -T, --show-transaction When enqueuing a unit job (for example as effect of a systemctl start invocation or similar), show brief information about all jobs enqueued, covering both the requested job and any added because of unit dependencies. Note that the output will only include jobs immediately part of the transaction requested. It is possible that service start-up program code run as effect of the enqueued jobs might request further jobs to be pulled in. This means that completion of the listed jobs might ultimately entail more jobs than the listed ones. Added in version 242. --fail Shorthand for --job-mode=fail. When used with the kill command, if no units were killed, the operation results in an error. Added in version 227. --check-inhibitors= When system shutdown or sleep state is requested, this option controls checking of inhibitor locks. It takes one of "auto", "yes" or "no". Defaults to "auto", which will behave like "yes" for interactive invocations (i.e. from a TTY) and "no" for non-interactive invocations. "yes" lets the request respect inhibitor locks. "no" lets the request ignore inhibitor locks. Applications can establish inhibitor locks to prevent certain important operations (such as CD burning) from being interrupted by system shutdown or sleep. Any user may take these locks and privileged users may override these locks. If any locks are taken, shutdown and sleep state requests will normally fail (unless privileged). However, if "no" is specified or "auto" is specified on a non-interactive requests, the operation will be attempted. If locks are present, the operation may require additional privileges. Option --force provides another way to override inhibitors. Added in version 248. -i Shortcut for --check-inhibitors=no. Added in version 198. --dry-run Just print what would be done. Currently supported by verbs halt, poweroff, reboot, kexec, suspend, hibernate, hybrid-sleep, suspend-then-hibernate, default, rescue, emergency, and exit. Added in version 236. -q, --quiet Suppress printing of the results of various commands and also the hints about truncated log lines. This does not suppress output of commands for which the printed output is the only result (like show). Errors are always printed. --no-warn Don't generate the warnings shown by default in the following cases: • when systemctl is invoked without procfs mounted on /proc/, • when using enable or disable on units without install information (i.e. don't have or have an empty [Install] section), • when using disable combined with --user on units that are enabled in global scope, • when a stop-ped, disable-d, or mask-ed unit still has active triggering units. Added in version 253. --no-block Do not synchronously wait for the requested operation to finish. If this is not specified, the job will be verified, enqueued and systemctl will wait until the unit's start-up is completed. By passing this argument, it is only verified and enqueued. This option may not be combined with --wait. --wait Synchronously wait for started units to terminate again. This option may not be combined with --no-block. Note that this will wait forever if any given unit never terminates (by itself or by getting stopped explicitly); particularly services which use "RemainAfterExit=yes". When used with is-system-running, wait until the boot process is completed before returning. Added in version 232. --user Talk to the service manager of the calling user, rather than the service manager of the system. --system Talk to the service manager of the system. This is the implied default. --failed List units in failed state. This is equivalent to --state=failed. Added in version 233. --no-wall Do not send wall message before halt, power-off and reboot. --global When used with enable and disable, operate on the global user configuration directory, thus enabling or disabling a unit file globally for all future logins of all users. --no-reload When used with enable and disable, do not implicitly reload daemon configuration after executing the changes. --no-ask-password When used with start and related commands, disables asking for passwords. Background services may require input of a password or passphrase string, for example to unlock system hard disks or cryptographic certificates. Unless this option is specified and the command is invoked from a terminal, systemctl will query the user on the terminal for the necessary secrets. Use this option to switch this behavior off. In this case, the password must be supplied by some other means (for example graphical password agents) or the service might fail. This also disables querying the user for authentication for privileged operations. --kill-whom= When used with kill, choose which processes to send a UNIX process signal to. Must be one of main, control or all to select whether to kill only the main process, the control process or all processes of the unit. The main process of the unit is the one that defines the life-time of it. A control process of a unit is one that is invoked by the manager to induce state changes of it. For example, all processes started due to the ExecStartPre=, ExecStop= or ExecReload= settings of service units are control processes. Note that there is only one control process per unit at a time, as only one state change is executed at a time. For services of type Type=forking, the initial process started by the manager for ExecStart= is a control process, while the process ultimately forked off by that one is then considered the main process of the unit (if it can be determined). This is different for service units of other types, where the process forked off by the manager for ExecStart= is always the main process itself. A service unit consists of zero or one main process, zero or one control process plus any number of additional processes. Not all unit types manage processes of these types however. For example, for mount units, control processes are defined (which are the invocations of /usr/bin/mount and /usr/bin/umount), but no main process is defined. If omitted, defaults to all. Added in version 252. --kill-value=INT If used with the kill command, enqueues a signal along with the specified integer value parameter to the specified process(es). This operation is only available for POSIX Realtime Signals (i.e. --signal=SIGRTMIN+... or --signal=SIGRTMAX-...), and ensures the signals are generated via the sigqueue(3) system call, rather than kill(3). The specified value must be a 32-bit signed integer, and may be specified either in decimal, in hexadecimal (if prefixed with "0x"), octal (if prefixed with "0o") or binary (if prefixed with "0b") If this option is used the signal will only be enqueued on the control or main process of the unit, never on other processes belonging to the unit, i.e. --kill-whom=all will only affect main and control processes but no other processes. Added in version 254. -s, --signal= When used with kill, choose which signal to send to selected processes. Must be one of the well-known signal specifiers such as SIGTERM, SIGINT or SIGSTOP. If omitted, defaults to SIGTERM. The special value "help" will list the known values and the program will exit immediately, and the special value "list" will list known values along with the numerical signal numbers and the program will exit immediately. --what= Select what type of per-unit resources to remove when the clean command is invoked, see above. Takes one of configuration, state, cache, logs, runtime, fdstore to select the type of resource. This option may be specified more than once, in which case all specified resource types are removed. Also accepts the special value all as a shortcut for specifying all six resource types. If this option is not specified defaults to the combination of cache, runtime and fdstore, i.e. the three kinds of resources that are generally considered to be redundant and can be reconstructed on next invocation. Note that the explicit removal of the fdstore resource type is only useful if the FileDescriptorStorePreserve= option is enabled, since the file descriptor store is otherwise cleaned automatically when the unit is stopped. Added in version 243. -f, --force When used with enable, overwrite any existing conflicting symlinks. When used with edit, create all of the specified units which do not already exist. When used with halt, poweroff, reboot or kexec, execute the selected operation without shutting down all units. However, all processes will be killed forcibly and all file systems are unmounted or remounted read-only. This is hence a drastic but relatively safe option to request an immediate reboot. If --force is specified twice for these operations (with the exception of kexec), they will be executed immediately, without terminating any processes or unmounting any file systems. Warning: specifying --force twice with any of these operations might result in data loss. Note that when --force is specified twice the selected operation is executed by systemctl itself, and the system manager is not contacted. This means the command should succeed even when the system manager has crashed. --message= When used with halt, poweroff or reboot, set a short message explaining the reason for the operation. The message will be logged together with the default shutdown message. Added in version 225. --now When used with enable, the units will also be started. When used with disable or mask, the units will also be stopped. The start or stop operation is only carried out when the respective enable or disable operation has been successful. Added in version 220. --root= When used with enable/disable/is-enabled (and related commands), use the specified root path when looking for unit files. If this option is present, systemctl will operate on the file system directly, instead of communicating with the systemd daemon to carry out changes. --image=image Takes a path to a disk image file or block device node. If specified, all operations are applied to file system in the indicated disk image. This option is similar to --root=, but operates on file systems stored in disk images or block devices. The disk image should either contain just a file system or a set of file systems within a GPT partition table, following the Discoverable Partitions Specification[2]. For further information on supported disk images, see systemd-nspawn(1)'s switch of the same name. Added in version 252. --image-policy=policy Takes an image policy string as argument, as per systemd.image-policy(7). The policy is enforced when operating on the disk image specified via --image=, see above. If not specified defaults to the "*" policy, i.e. all recognized file systems in the image are used. --runtime When used with enable, disable, edit, (and related commands), make changes only temporarily, so that they are lost on the next reboot. This will have the effect that changes are not made in subdirectories of /etc/ but in /run/, with identical immediate effects, however, since the latter is lost on reboot, the changes are lost too. Similarly, when used with set-property, make changes only temporarily, so that they are lost on the next reboot. --preset-mode= Takes one of "full" (the default), "enable-only", "disable-only". When used with the preset or preset-all commands, controls whether units shall be disabled and enabled according to the preset rules, or only enabled, or only disabled. Added in version 215. -n, --lines= When used with status, controls the number of journal lines to show, counting from the most recent ones. Takes a positive integer argument, or 0 to disable journal output. Defaults to 10. -o, --output= When used with status, controls the formatting of the journal entries that are shown. For the available choices, see journalctl(1). Defaults to "short". --firmware-setup When used with the reboot, poweroff, or halt command, indicate to the system's firmware to reboot into the firmware setup interface for the next boot. Note that this functionality is not available on all systems. Added in version 220. --boot-loader-menu=timeout When used with the reboot, poweroff, or halt command, indicate to the system's boot loader to show the boot loader menu on the following boot. Takes a time value as parameter — indicating the menu timeout. Pass zero in order to disable the menu timeout. Note that not all boot loaders support this functionality. Added in version 242. --boot-loader-entry=ID When used with the reboot, poweroff, or halt command, indicate to the system's boot loader to boot into a specific boot loader entry on the following boot. Takes a boot loader entry identifier as argument, or "help" in order to list available entries. Note that not all boot loaders support this functionality. Added in version 242. --reboot-argument= This switch is used with reboot. The value is architecture and firmware specific. As an example, "recovery" might be used to trigger system recovery, and "fota" might be used to trigger a “firmware over the air” update. Added in version 246. --plain When used with list-dependencies, list-units or list-machines, the output is printed as a list instead of a tree, and the bullet circles are omitted. Added in version 203. --timestamp= Change the format of printed timestamps. The following values may be used: pretty (this is the default) "Day YYYY-MM-DD HH:MM:SS TZ" Added in version 248. unix "@seconds-since-the-epoch" Added in version 251. us, μs "Day YYYY-MM-DD HH:MM:SS.UUUUUU TZ" Added in version 248. utc "Day YYYY-MM-DD HH:MM:SS UTC" Added in version 248. us+utc, μs+utc "Day YYYY-MM-DD HH:MM:SS.UUUUUU UTC" Added in version 248. Added in version 247. --mkdir When used with bind, creates the destination file or directory before applying the bind mount. Note that even though the name of this option suggests that it is suitable only for directories, this option also creates the destination file node to mount over if the object to mount is not a directory, but a regular file, device node, socket or FIFO. Added in version 248. --marked Only allowed with reload-or-restart. Enqueues restart jobs for all units that have the "needs-restart" mark, and reload jobs for units that have the "needs-reload" mark. When a unit marked for reload does not support reload, restart will be queued. Those properties can be set using set-property Markers=.... Unless --no-block is used, systemctl will wait for the queued jobs to finish. Added in version 248. --read-only When used with bind, creates a read-only bind mount. Added in version 248. --drop-in=NAME When used with edit, use NAME as the drop-in file name instead of override.conf. Added in version 253. --when= When used with halt, poweroff, reboot or kexec, schedule the action to be performed at the given timestamp, which should adhere to the syntax documented in systemd.time(7) section "PARSING TIMESTAMPS". Specially, if "show" is given, the currently scheduled action will be shown, which can be canceled by passing an empty string or "cancel". Added in version 254. -H, --host= Execute the operation remotely. Specify a hostname, or a username and hostname separated by "@", to connect to. The hostname may optionally be suffixed by a port ssh is listening on, separated by ":", and then a container name, separated by "/", which connects directly to a specific container on the specified host. This will use SSH to talk to the remote machine manager instance. Container names may be enumerated with machinectl -H HOST. Put IPv6 addresses in brackets. -M, --machine= Execute operation on a local container. Specify a container name to connect to, optionally prefixed by a user name to connect as and a separating "@" character. If the special string ".host" is used in place of the container name, a connection to the local system is made (which is useful to connect to a specific user's user bus: "--user [email protected]"). If the "@" syntax is not used, the connection is made as root user. If the "@" syntax is used either the left hand side or the right hand side may be omitted (but not both) in which case the local user name and ".host" are implied. --no-pager Do not pipe output into a pager. --legend=BOOL Enable or disable printing of the legend, i.e. column headers and the footer with hints. The legend is printed by default, unless disabled with --quiet or similar. -h, --help Print a short help text and exit. --version Print a short version string and exit. EXIT STATUS On success, 0 is returned, a non-zero failure code otherwise. systemctl uses the return codes defined by LSB, as defined in LSB 3.0.0[3]. Table 3. LSB return codes ┌───────┬────────────────────────────────────────┬─────────────────────────────────────┐ │ Value │ Description in LSB │ Use in systemd │ ├───────┼────────────────────────────────────────┼─────────────────────────────────────┤ │ 0 │ "program is running or service is OK" │ unit is active │ ├───────┼────────────────────────────────────────┼─────────────────────────────────────┤ │ 1 │ "program is dead and /var/run pid file │ unit not failed (used by is-failed) │ │ │ exists" │ │ ├───────┼────────────────────────────────────────┼─────────────────────────────────────┤ │ 2 │ "program is dead and /var/lock lock │ unused │ │ │ file exists" │ │ ├───────┼────────────────────────────────────────┼─────────────────────────────────────┤ │ 3 │ "program is not running" │ unit is not active │ ├───────┼────────────────────────────────────────┼─────────────────────────────────────┤ │ 4 │ "program or service status is unknown" │ no such unit │ └───────┴────────────────────────────────────────┴─────────────────────────────────────┘ The mapping of LSB service states to systemd unit states is imperfect, so it is better to not rely on those return values but to look for specific unit states and substates instead. ENVIRONMENT $SYSTEMD_EDITOR Editor to use when editing units; overrides $EDITOR and $VISUAL. If neither $SYSTEMD_EDITOR nor $EDITOR nor $VISUAL are present or if it is set to an empty string or if their execution failed, systemctl will try to execute well known editors in this order: editor(1), nano(1), vim(1), vi(1). Added in version 218. $SYSTEMD_LOG_LEVEL The maximum log level of emitted messages (messages with a higher log level, i.e. less important ones, will be suppressed). Either one of (in order of decreasing importance) emerg, alert, crit, err, warning, notice, info, debug, or an integer in the range 0...7. See syslog(3) for more information. $SYSTEMD_LOG_COLOR A boolean. If true, messages written to the tty will be colored according to priority. This setting is only useful when messages are written directly to the terminal, because journalctl(1) and other tools that display logs will color messages based on the log level on their own. $SYSTEMD_LOG_TIME A boolean. If true, console log messages will be prefixed with a timestamp. This setting is only useful when messages are written directly to the terminal or a file, because journalctl(1) and other tools that display logs will attach timestamps based on the entry metadata on their own. $SYSTEMD_LOG_LOCATION A boolean. If true, messages will be prefixed with a filename and line number in the source code where the message originates. Note that the log location is often attached as metadata to journal entries anyway. Including it directly in the message text can nevertheless be convenient when debugging programs. $SYSTEMD_LOG_TARGET The destination for log messages. One of console (log to the attached tty), console-prefixed (log to the attached tty but with prefixes encoding the log level and "facility", see syslog(3), kmsg (log to the kernel circular log buffer), journal (log to the journal), journal-or-kmsg (log to the journal if available, and to kmsg otherwise), auto (determine the appropriate log target automatically, the default), null (disable log output). $SYSTEMD_PAGER Pager to use when --no-pager is not given; overrides $PAGER. If neither $SYSTEMD_PAGER nor $PAGER are set, a set of well-known pager implementations are tried in turn, including less(1) and more(1), until one is found. If no pager implementation is discovered no pager is invoked. Setting this environment variable to an empty string or the value "cat" is equivalent to passing --no-pager. Note: if $SYSTEMD_PAGERSECURE is not set, $SYSTEMD_PAGER (as well as $PAGER) will be silently ignored. $SYSTEMD_LESS Override the options passed to less (by default "FRSXMK"). Users might want to change two options in particular: K This option instructs the pager to exit immediately when Ctrl+C is pressed. To allow less to handle Ctrl+C itself to switch back to the pager command prompt, unset this option. If the value of $SYSTEMD_LESS does not include "K", and the pager that is invoked is less, Ctrl+C will be ignored by the executable, and needs to be handled by the pager. X This option instructs the pager to not send termcap initialization and deinitialization strings to the terminal. It is set by default to allow command output to remain visible in the terminal even after the pager exits. Nevertheless, this prevents some pager functionality from working, in particular paged output cannot be scrolled with the mouse. See less(1) for more discussion. $SYSTEMD_LESSCHARSET Override the charset passed to less (by default "utf-8", if the invoking terminal is determined to be UTF-8 compatible). $SYSTEMD_PAGERSECURE Takes a boolean argument. When true, the "secure" mode of the pager is enabled; if false, disabled. If $SYSTEMD_PAGERSECURE is not set at all, secure mode is enabled if the effective UID is not the same as the owner of the login session, see geteuid(2) and sd_pid_get_owner_uid(3). In secure mode, LESSSECURE=1 will be set when invoking the pager, and the pager shall disable commands that open or create new files or start new subprocesses. When $SYSTEMD_PAGERSECURE is not set at all, pagers which are not known to implement secure mode will not be used. (Currently only less(1) implements secure mode.) Note: when commands are invoked with elevated privileges, for example under sudo(8) or pkexec(1), care must be taken to ensure that unintended interactive features are not enabled. "Secure" mode for the pager may be enabled automatically as describe above. Setting SYSTEMD_PAGERSECURE=0 or not removing it from the inherited environment allows the user to invoke arbitrary commands. Note that if the $SYSTEMD_PAGER or $PAGER variables are to be honoured, $SYSTEMD_PAGERSECURE must be set too. It might be reasonable to completely disable the pager using --no-pager instead. $SYSTEMD_COLORS Takes a boolean argument. When true, systemd and related utilities will use colors in their output, otherwise the output will be monochrome. Additionally, the variable can take one of the following special values: "16", "256" to restrict the use of colors to the base 16 or 256 ANSI colors, respectively. This can be specified to override the automatic decision based on $TERM and what the console is connected to. $SYSTEMD_URLIFY The value must be a boolean. Controls whether clickable links should be generated in the output for terminal emulators supporting this. This can be specified to override the decision that systemd makes based on $TERM and other conditions. SEE ALSO systemd(1), journalctl(1), loginctl(1), machinectl(1), systemd.unit(5), systemd.resource-control(5), systemd.special(7), wall(1), systemd.preset(5), systemd.generator(7), glob(7) NOTES 1. Boot Loader Specification https://uapi-group.org/specifications/specs/boot_loader_specification 2. Discoverable Partitions Specification https://uapi-group.org/specifications/specs/discoverable_partitions_specification 3. LSB 3.0.0 http://refspecs.linuxbase.org/LSB_3.0.0/LSB-PDA/LSB-PDA/iniscrptact.html systemd 255 SYSTEMCTL(1)