1GIT-FSMONITOR--DAEMON(1)          Git Manual          GIT-FSMONITOR--DAEMON(1)
2
3
4

NAME

6       git-fsmonitor--daemon - A Built-in Filesystem Monitor
7

SYNOPSIS

9       git fsmonitor--daemon start
10       git fsmonitor--daemon run
11       git fsmonitor--daemon stop
12       git fsmonitor--daemon status
13

DESCRIPTION

15       A daemon to watch the working directory for file and directory changes
16       using platform-specific filesystem notification facilities.
17
18       This daemon communicates directly with commands like git status using
19       the simple IPC[1] interface instead of the slower githooks(5)
20       interface.
21
22       This daemon is built into Git so that no third-party tools are
23       required.
24

OPTIONS

26       start
27           Starts a daemon in the background.
28
29       run
30           Runs a daemon in the foreground.
31
32       stop
33           Stops the daemon running in the current working directory, if
34           present.
35
36       status
37           Exits with zero status if a daemon is watching the current working
38           directory.
39

REMARKS

41       This daemon is a long running process used to watch a single working
42       directory and maintain a list of the recently changed files and
43       directories. Performance of commands such as git status can be
44       increased if they just ask for a summary of changes to the working
45       directory and can avoid scanning the disk.
46
47       When core.fsmonitor is set to true (see git-config(1)) commands, such
48       as git status, will ask the daemon for changes and automatically start
49       it (if necessary).
50
51       For more information see the "File System Monitor" section in git-
52       update-index(1).
53

CAVEATS

55       The fsmonitor daemon does not currently know about submodules and does
56       not know to filter out filesystem events that happen within a
57       submodule. If fsmonitor daemon is watching a super repo and a file is
58       modified within the working directory of a submodule, it will report
59       the change (as happening against the super repo). However, the client
60       will properly ignore these extra events, so performance may be affected
61       but it will not cause an incorrect result.
62
63       By default, the fsmonitor daemon refuses to work with network-mounted
64       repositories; this may be overridden by setting fsmonitor.allowRemote
65       to true. Note, however, that the fsmonitor daemon is not guaranteed to
66       work correctly with all network-mounted repositories, so such use is
67       considered experimental.
68
69       On Mac OS, the inter-process communication (IPC) between various Git
70       commands and the fsmonitor daemon is done via a Unix domain socket
71       (UDS) — a special type of file — which is supported by native Mac OS
72       filesystems, but not on network-mounted filesystems, NTFS, or FAT32.
73       Other filesystems may or may not have the needed support; the fsmonitor
74       daemon is not guaranteed to work with these filesystems and such use is
75       considered experimental.
76
77       By default, the socket is created in the .git directory. However, if
78       the .git directory is on a network-mounted filesystem, it will instead
79       be created at $HOME/.git-fsmonitor-* unless $HOME itself is on a
80       network-mounted filesystem, in which case you must set the
81       configuration variable fsmonitor.socketDir to the path of a directory
82       on a Mac OS native filesystem in which to create the socket file.
83
84       If none of the above directories (.git, $HOME, or fsmonitor.socketDir)
85       is on a native Mac OS file filesystem the fsmonitor daemon will report
86       an error that will cause the daemon and the currently running command
87       to exit.
88

CONFIGURATION

90       Everything below this line in this section is selectively included from
91       the git-config(1) documentation. The content is the same as what’s
92       found there:
93
94       fsmonitor.allowRemote
95           By default, the fsmonitor daemon refuses to work with
96           network-mounted repositories. Setting fsmonitor.allowRemote to true
97           overrides this behavior. Only respected when core.fsmonitor is set
98           to true.
99
100       fsmonitor.socketDir
101           This Mac OS-specific option, if set, specifies the directory in
102           which to create the Unix domain socket used for communication
103           between the fsmonitor daemon and various Git commands. The
104           directory must reside on a native Mac OS filesystem. Only respected
105           when core.fsmonitor is set to true.
106

GIT

108       Part of the git(1) suite
109

NOTES

111        1. simple IPC
112           file:///usr/share/doc/git/technical/api-simple-ipc.html
113
114
115
116Git 2.43.0                        11/20/2023          GIT-FSMONITOR--DAEMON(1)
Impressum