Improve documentation (installation, env variable, faq, support) #29
Conversation
AltNico
changed the title
docs/usage.rst
Outdated
| @@ -12,6 +12,12 @@ options. The following sections will describe each in detail. | |||
| General | |||
| ------- | |||
|
|
|||
| Note that |project_name| will ask you for your repo's passphrase | |||
| which blocks the import until you enter it. To let |project_name| | |||
| continue automatically, you can pass the environmental variable | |||
There was a problem hiding this comment.
also, it is borg asking for the passphrase, right? not borg-import.
There was a problem hiding this comment.
environment variable
Done, thanks!
also, it is borg asking for the passphrase, right? not borg-import.
This might be right technically, but to me as a user it seems like borg-import asked for it, since I executed a borg-import command and not a borg one.
However, I can change it from borg-import to borg if you want. I just think that it might confuse people not knowing the relationship between borg and borg-import.
| @@ -4,7 +4,8 @@ What is borg-import? | |||
| borg-import can import backups from some other backup software, currently supported are: | |||
|
|
|||
| - rsnapshot | |||
| - simple rsync+hardlinks (One folder per archive, using folder mtime) | |||
| - ``rsynchl``: simple rsync+hardlinks (One folder per archive, using folder mtime) | |||
There was a problem hiding this comment.
maybe rather use rsync-hl or rsync+hardlinks as shortcut for this.
having the char sequence synch (-> synchronization) in there makes it difficult to see what it means for people who do not know already.
There was a problem hiding this comment.
I added rsynchl because I wanted to directly give users the mode to call with borg-import. I agree that rsynchl should might get renamed to something like rsync-hl, but this is out of scope of this PR.
Partly as a result of #14.
|
thanks! |
Partly as a result of #14.