mir/MEGAcmd
2
0
Fork 0
mirror of https://github.com/meganz/MEGAcmd synced 2025-08-31 13:55:10 +00:00
Code Issues Releases Wiki Activity

Add documentation to sync-issues command

Browse Source
This commit is contained in:
Diego Ximenez
2024-12-03 13:14:07 +01:00
parent 5bcf2f5beb
commit cc0a750eca
6 changed files with 86 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
contrib/docs/commands/sync-issues.md Normal file
View File

@@ -0,0 +1,32 @@
### sync-issues
Show all issues with current syncs
Usage: `sync-issues [[--detail (ID|--all)] [--limit=rowcount] [--disable-path-collapse]] | [--enable-warning|--disable-warning]`
<pre>
When MEGAcmd detects conflicts with the data it's synchronizing, a sync issue is triggered. Syncing is stopped, and no progress is made on the conflicting data.
A notification will appear when sync issues are detected. Because the sync engine might clear the internal issue list when processing, the notification can appear even if there were already issues before.
Note: the sync issue list might not contain the latest updated data. Some issues might still be being processing by the sync engine, and some might not have been removed yet.
Options:
--detail (ID | --all) Provides additional information on a particular sync issue.
The ID of the sync where this issue appeared is shown, alongside its local and cloud paths.
All paths involved in the issue are shown. For each path, the following columns are displayed:
PATH: The conflicting local or cloud path (cloud paths are prefixed with "<CLOUD>").
PATH_ISSUE: A brief explanation of the problem this file or folder has (if any).
LAST_MODIFIED: The most recent date when this file or directory was updated.
UPLOADED: For cloud paths, the date of upload or creation. Empty for local paths.
SIZE: The size of the file. Empty for directories.
TYPE: The type of the path (file or directory). This column is hidden if the information it's not relevant for the particular sync issue.
The "--all" argument can be used to show the details of all issues.
--limit=rowcount Limits the amount of rows displayed. Can also be combined with "--detail".
--disable-path-collapse Ensures all paths are fully shown. By default long paths are truncated for readability.
--enable-warning Enables the notification that appears when issues are detected. This setting is stored locally for all users.
--disable-warning Disables the notification that appears when issues are detected. This setting is stored locally for all users.
--col-separator=X Use the string "X" as column separator. Otherwise, spaces will be added between columns to align them.
--output-cols=COLUMN_NAME_1,COLUMN_NAME2,... Select which columns to show and their order.
DISPLAYED columns:
ISSUE_ID: A unique identifier of the sync issue. The ID can be used alongside the "--detail" argument.
PARENT_SYNC: The identifier of the sync that has this issue.
REASON: A brief explanation on what the issue is. Use the "--detail" argument to get extended information on a particular sync.
</pre>

17
contrib/docs/commands/sync.md
View File

@@ -12,17 +12,16 @@ If an ID/local path is provided, it will list such synchronization
unless an option is specified.
Options:
-d | --delete ID|localpath deletes a synchronization (not the files).
-p | --pause ID|localpath pauses (disables) a synchronization.
-e | --enable ID|localpath resumes a synchronization.
[deprecated] --remove ID|localpath same as --delete.
[deprecated] -s | --disable ID|localpath same as --pause.
[deprecated] -r ID|localpath same as --enable.
-d | --delete ID|localpath deletes a synchronization (not the files).
-p | --pause ID|localpath pauses (disables) a synchronization.
-e | --enable ID|localpath resumes a synchronization.
[deprecated] --remove ID|localpath same as --delete.
[deprecated] -s | --disable ID|localpath same as --pause.
[deprecated] -r ID|localpath same as --enable.
--path-display-size=N Use at least N characters for displaying paths.
--show-handles Prints remote nodes handles (H:XXXXXXXX).
--col-separator=X Tt will use X as column separator. Otherwise the output will use
spaces to tabulate in an easy to read output:
--output-cols=COLUMN_NAME_1,COLUMN_NAME2,... You can select which columns to show (and their order) with this option
--col-separator=X Use the string "X" as column separator. Otherwise, spaces will be added between columns to align them.
--output-cols=COLUMN_NAME_1,COLUMN_NAME2,... Select which columns to show and their order.
DISPLAYED columns:
ID: an unique identifier of the sync.

5
contrib/docs/commands/transfers.md
View File

@@ -18,9 +18,8 @@ Show options:
--only-completed Show only completed download
--limit=N Show only first N transfers
--path-display-size=N Use at least N characters for displaying paths
--col-separator=X Tt will use X as column separator. Otherwise the output will use
spaces to tabulate in an easy to read output:
--output-cols=COLUMN_NAME_1,COLUMN_NAME2,... You can select which columns to show (and their order) with this option
--col-separator=X Use the string "X" as column separator. Otherwise, spaces will be added between columns to align them.
--output-cols=COLUMN_NAME_1,COLUMN_NAME2,... Select which columns to show and their order.
TYPE legend correspondence:
⇓ = Download transfer