You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/docs/scan&watch.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,11 +7,11 @@ Scanning can be triggered in the following four ways:
7
7
* When starting ComicLib, perform a full scan
8
8
* After ComicLib is started, if `watch=True`, creation/modification events (only files) are monitored in the directory indicated by the `content` environment variable.
9
9
* Manually run the `comicscan` command for a full scan
10
-
* Call the `scan` interface to scan a single file/folder, e.g.:
10
+
* Call the `scan` interface to scan a specific file/folder, e.g.:
11
11
12
12
```python
13
13
from comiclib.scan import scan
14
-
scan("content/comic/to/scan") # The path should be a subpath to the directory indicated by the `content` environment variable
14
+
scan(["content/comic/to/scan"]) # The path should be a subpath to the directory indicated by the `content` environment variable
15
15
# For folders, this means trying to treat the folder itself as a comic rather than searching for multiple comics in it
16
16
```
17
17
@@ -22,4 +22,6 @@ Use the same environment variables when executing the above command. If the sett
22
22
* All files/folders in the directory indicated by the `content` environment variable are candidates for comics
23
23
* Relative paths are an important identifier of comics. This means that if a comic is moved elsewhere, ComicLib will think it is another comic; comics with the same path will be skipped when rescanning, unless `skip_exists=False`; move the entire comic library elsewhere and modify the `content` environment variable to keep the relative relationship unchanged will not need a rescanning.
24
24
* The main part of ComicLib is only responsible for traversing the comic library. The judgment of comic files are completed through scanners.
25
-
*[Scanner script](scanner.md) is also responsible for metadata analysis and thumbnail extraction of comics.
25
+
*[Scanner](scanner.md) is also responsible for metadata analysis and thumbnail extraction of comics.
26
+
* During a complete scan, if an error occurs in the [scanner](scanner.md), the entire scan will be stopped to allow the user to determine the error, but the scan progress will be retained.
27
+
* Errors encountered during monitoring will be ignored.
0 commit comments