Improve READMEs

This commit is contained in:
Matteo Cypriani 2017-09-22 16:44:57 -04:00
parent 514c044088
commit 6ebe287e2f
4 changed files with 16 additions and 15 deletions

View File

@ -3,7 +3,7 @@
obstinate-rsync.sh is a simple script that transfers a single directory obstinate-rsync.sh is a simple script that transfers a single directory
(your home directory, by default) to a remote host, using rsync. You can (your home directory, by default) to a remote host, using rsync. You can
specify exclude patterns in a file (~/.backup-excludes by default). The specify exclude patterns in a file (~/.backup-excludes by default). The
transfer will be reattempted until it succeed. transfer will be reattempted until it succeeds.
Edit the script to configure the protocol, host, directories, etc. Edit the script to configure the protocol, host, directories, etc.

View File

@ -22,7 +22,7 @@ for example:
priam priam
``` ```
The scrits based on SSH use the local user's login name as remote login; The scripts based on SSH use the local user's login name as remote login;
this can be changed using the ``-l`` option, that must appear before the this can be changed using the ``-l`` option, that must appear before the
hosts' list on the command line, for example: hosts' list on the command line, for example:
@ -59,16 +59,16 @@ Dependency: parallel-ssh (pssh)
Deploy one or more files in parallel on every host of the hosts' list. Deploy one or more files in parallel on every host of the hosts' list.
The files are copied in the remote user's home directory. The files are copied in the remote user's home directory.
By default, the files are transfered one by one, to be sure to notice By default, the files are transferred one by one, to make sure you notice
the errors for each file (bad permissions, out of space, etc.), but the the errors for each file (bad permissions, out of space, etc.), but you
-P option allows to transfer them all together. can use the -P switch to transfer them all at once (faster).
While it is possible to transfer directories with the default option, to While it is possible to transfer directories with the default option, to
synchronise directories one would rather use the -r option, that uses synchronise directories one would rather use the -r option, that uses
prsync rather than pscp to transfer the files. With the -R option, the prsync rather than pscp to transfer the files. With the -R option, the
remote files that are not in the local copy will be deleted (rsync's remote files that are not in the local copy will be deleted (rsync's
--delete option). With both options, the transfer is done with rsync's --delete option). In both cases, the transfer is done with rsync's -a
-a (archive) option. (archive) option.
Please note that unlike rsync, prsync cannot handle multiple local Please note that unlike rsync, prsync cannot handle multiple local
files, therefore the -P option is ignored when passed along with -r or files, therefore the -P option is ignored when passed along with -r or

View File

@ -3,11 +3,11 @@
The lz.sh script emulates and extends commands lz and uz from the The lz.sh script emulates and extends commands lz and uz from the
mtools. mtools.
NOTE: although more powerful than their mtools equivalent, you should NOTE: although lz.sh is more powerful than mtools' lz and uz, you should
probably use als and aunpack from the atool package rather than these probably use als and aunpack from the atool package instead; they are
commands; they are much better and there are several other useful much better and atool provides several other useful commands as well.
commands provided by atool. This script is still useful when you can't This script is still useful when you can't install Perl (atool is
install Perl (atool ist written in Perl). written in Perl).
This script handles the following archive formats through the standards This script handles the following archive formats through the standards
options of GNU Tar: options of GNU Tar:
@ -17,6 +17,7 @@ options of GNU Tar:
- tar.xz (txz) - tar.xz (txz)
- tar.lzma (tlz) - tar.lzma (tlz)
- tar.Z (taz) - tar.Z (taz)
Note that you need GNU Tar, at least version 1.20 to support LZMA Note that you need GNU Tar, at least version 1.20 to support LZMA
compressed archives, and version 1.22 for XZ compressed ones. compressed archives, and version 1.22 for XZ compressed ones.
@ -50,4 +51,4 @@ file is removed.
NOTE: the atool package provides the arepack command, which can NOTE: the atool package provides the arepack command, which can
recompress to several formats and not only to xz. xzize has the recompress to several formats and not only to xz. xzize has the
advantage to recompress on the fly rather than unpacking the archive advantage to recompress on the fly rather than unpacking the archive
entirely on the file system and repacking it after. entirely on the file system and repacking it afterwards.

View File

@ -8,7 +8,7 @@ One can edit the options into the script to change the message displayed
at the top of the changelog, and the number of line to separate two tag at the top of the changelog, and the number of line to separate two tag
messages. messages.
The changelog is displayed on the standard output, in revese order The changelog is displayed on the standard output, in reverse order
(higher version numbers first), whereas the error output displays the (higher version numbers first), whereas the error output displays the
included or skipped tag names (i.e. those which do not correspond to the included or skipped tag names (i.e. those which do not correspond to the
pattern). pattern).
@ -35,7 +35,7 @@ reset.
Usage: Usage:
git-cherry-move source_branch destination_branch [ reset-arg ] git-cherry-move source_branch destination_branch [ reset-arg ]
reset-arg is passed as the first argument of reset, so pleas be careful! reset-arg is passed as the first argument of reset, so please be careful!
To move the last commit of source_branch on top of destination_branch, To move the last commit of source_branch on top of destination_branch,
you can type the following: you can type the following: