|
| 1 | +git-fsmonitor--daemon(1) |
| 2 | +======================== |
| 3 | + |
| 4 | +NAME |
| 5 | +---- |
| 6 | +git-fsmonitor--daemon - A Built-in File System Monitor |
| 7 | + |
| 8 | +SYNOPSIS |
| 9 | +-------- |
| 10 | +[verse] |
| 11 | +'git fsmonitor--daemon' start |
| 12 | +'git fsmonitor--daemon' run |
| 13 | +'git fsmonitor--daemon' stop |
| 14 | +'git fsmonitor--daemon' status |
| 15 | + |
| 16 | +DESCRIPTION |
| 17 | +----------- |
| 18 | + |
| 19 | +A daemon to watch the working directory for file and directory |
| 20 | +changes using platform-specific file system notification facilities. |
| 21 | + |
| 22 | +This daemon communicates directly with commands like `git status` |
| 23 | +using the link:technical/api-simple-ipc.html[simple IPC] interface |
| 24 | +instead of the slower linkgit:githooks[5] interface. |
| 25 | + |
| 26 | +This daemon is built into Git so that no third-party tools are |
| 27 | +required. |
| 28 | + |
| 29 | +OPTIONS |
| 30 | +------- |
| 31 | + |
| 32 | +start:: |
| 33 | + Starts a daemon in the background. |
| 34 | + |
| 35 | +run:: |
| 36 | + Runs a daemon in the foreground. |
| 37 | + |
| 38 | +stop:: |
| 39 | + Stops the daemon running in the current working |
| 40 | + directory, if present. |
| 41 | + |
| 42 | +status:: |
| 43 | + Exits with zero status if a daemon is watching the |
| 44 | + current working directory. |
| 45 | + |
| 46 | +REMARKS |
| 47 | +------- |
| 48 | + |
| 49 | +This daemon is a long running process used to watch a single working |
| 50 | +directory and maintain a list of the recently changed files and |
| 51 | +directories. Performance of commands such as `git status` can be |
| 52 | +increased if they just ask for a summary of changes to the working |
| 53 | +directory and can avoid scanning the disk. |
| 54 | + |
| 55 | +When `core.useBuiltinFSMonitor` is set to `true` (see |
| 56 | +linkgit:git-config[1]) commands, such as `git status`, will ask the |
| 57 | +daemon for changes and automatically start it (if necessary). |
| 58 | + |
| 59 | +For more information see the "File System Monitor" section in |
| 60 | +linkgit:git-update-index[1]. |
| 61 | + |
| 62 | +CAVEATS |
| 63 | +------- |
| 64 | + |
| 65 | +The fsmonitor daemon does not currently know about submodules and does |
| 66 | +not know to filter out file system events that happen within a |
| 67 | +submodule. If fsmonitor daemon is watching a super repo and a file is |
| 68 | +modified within the working directory of a submodule, it will report |
| 69 | +the change (as happening against the super repo). However, the client |
| 70 | +will properly ignore these extra events, so performance may be affected |
| 71 | +but it will not cause an incorrect result. |
| 72 | + |
| 73 | +GIT |
| 74 | +--- |
| 75 | +Part of the linkgit:git[1] suite |
0 commit comments