Commit e66c5b6c authored by Yuanle Song's avatar Yuanle Song
Browse files

v0.5.3.0 update README.md

parent ddace85b
......@@ -5,6 +5,7 @@ Intro
------
mbackup is a file backup tool based on [rsync](https://rsync.samba.org/).
It supports backup a list of files and dirs to local dir or remote ssh node.
Since mbackup is based on rsync, it supports incremental backup efficiently.
Difference with rsync: rsync doesn't have an official windows build. rsync
doesn't support windows style path in source, target, and file lists. You can
......@@ -33,11 +34,11 @@ By default, the following files are backed up by mbackup:
- C:\ProgramData\mbackup
- C:\Docs
- D:\Docs
- <User>\Documents
- <User>\Desktop
- <User>\Downloads
- <User>\Pictures\Saved Pictures\
- <User>\<dot files>
- Documents
- Desktop
- Downloads
- Pictures\Saved Pictures\
- <dot files> in %userprofile%
By default, some files are ignored, such as iso, rar, zip, exe etc. mbackup is
designed to backup user created contents, not downloaded contents. That's why
......@@ -48,15 +49,15 @@ You can add more dirs to backup in %programdata%\mbackup\local-list.txt
Here are the backup list files and exclude pattern files:
- backup file list
%programdata%\mbackup\default-list.txt
%programdata%\mbackup\user-default-list.txt
%programdata%\mbackup\local-list.txt (managed by user)
- %programdata%\mbackup\default-list.txt
- %programdata%\mbackup\user-default-list.txt
- %programdata%\mbackup\local-list.txt (managed by user)
- exclude pattern
%programdata%\mbackup\default-exclude.txt
%programdata%\mbackup\local-exclude.txt (managed by user)
- %programdata%\mbackup\default-exclude.txt
- %programdata%\mbackup\local-exclude.txt (managed by user)
local-list.txt and local-exclude.txt are managed by user and mbackup will not
local-list.txt and local-exclude.txt are managed by user. mbackup will not
modify those files when it is uninstalled or upgraded. The other lists are
shipped with mbackup and will be removed/overwritten when
uninstalling/upgrading mbackup.
......@@ -69,13 +70,15 @@ How to Invoke mbackup
----------------------
mbackup for windows is designed to run automatically in the background via
Windows Task Scheduler (Win+R taskschd.msc). You can also run in from windows
cmd or powershell to trigger a backup immediately.
Windows Task Scheduler (Win+R taskschd.msc). You can also run it from windows
cmd or powershell to trigger a backup immediately (or test setup or do initial
backup).
For the automatic backup to work, you need to specify a target in mbackup
config file.
Open mbackup config file %programdata%\mbackup\mbackup-config.txt,
Open mbackup config file in any text editor,
Win+R %programdata%\mbackup\mbackup-config.txt,
To backup to local disk, add config
......@@ -94,10 +97,10 @@ is supported. If you use password to login your server, you may learn
[how to set up ssh keys](https://www.digitalocean.com/community/tutorials/how-to-set-up-ssh-keys--2).
Save mbackup-config.txt file, now auto backup will work. The default scheduler
runs mbackup a few minutes after user logon and every 2 hours during
runs mbackup 15 minutes after user logon and every 2 hours during
daytime. You can open Task Scheduler to check the scheduler.
Here is how to run it in cmd or powershell:
Here is how to run mbackup in cmd or powershell:
%programfiles%\mbackup\publish\mbackup.exe --help
%programfiles%\mbackup\publish\mbackup.exe
......
......@@ -23,7 +23,7 @@
<RuntimeIdentifiers>win10-x64</RuntimeIdentifiers>
<RootNamespace>Mbackup</RootNamespace>
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
<Version>0.5.2.0</Version>
<Version>0.5.3.0</Version>
</PropertyGroup>
<ItemGroup>
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment