Merge pull request #86 from jousch/bugfix/umlauts

Remove auto umlauts and update documentation

Author: mblaschke

CHANGELOG.md

@@ -5,7 +5,7 @@ CliTools Changelog
 ------------------
 - Updated compile documentation
 - Improved compile scripts
-- Added umlauts support for rsync under OSX
+- Added rsync.opts documentation
 - Added rsync.opts section in `clisync.yml` for additional rsync options
 - No terminal title if stdout redirect is detected
 - Added `docker:cleanup` for cleanup of orphaned images and volumes

Documentation/COMMANDS.md

@@ -77,7 +77,7 @@ All log commands are using a grep-filter (specified as optional argument)
 |                            | __ct mysql:restore typo3 dump.sql.xz__ -> xz'ed (lzma'ed) sql dump        |
 |                            | __ct mysql:restore typo3 dump.sql --filter=typo3__ -> No TYPO3 cache tables in dump |
 | ct mysql:restore           | Create (and drops if already exists) a database and restore from a dump   |
-|                            | Dump file can be plaintext, gziped, bzip2 or lzma compressed              |
+|                            | Dump file can be plaintext, gzip, bzip2 or lzma compressed              |
 |                            | and will automatically detected                                           |
 |                            | __ct mysql:restore typo3 dump.sql.bz2__                                   |
 | ct mysql:convert           | Convert character set and collation of a database                         |

Documentation/Examples/clisync.yml

@@ -54,7 +54,6 @@ GLOBAL:
         workdir: ""
 
         # Additional options ("-rlptD --delete-after --progress --human-readable" is already set)
-        # (" --iconv=UTF8-MAC,UTF8" is automatically set if OS is OSX to enable Umlauts support)
         opts: ""
 
         # exclude list/patterns for files and directories

Documentation/INSTALL.md

@@ -1,4 +1,4 @@
-q[<-- Back to main section](../README.md)
+[<-- Back to main section](../README.md)
 
 # Installation
 
@@ -17,10 +17,13 @@ q[<-- Back to main section](../README.md)
   - sudo
   - moreutils (ifdata)
   - coreutils (grep, sort, uniq, awk, cat, df, ip, cut, lsb_release, wall)
-  - rsync (to prevent bugs with umlauts you have to use rsync with version >= 3.0)
+  - rsync (to prevent bugs with umlauts while you have to use rsync with version >= 3.0 (GNU version))
   - gnu-sed
   - docker and docker-compose (if you want to use docker)
   - mysql (if you want to use mysql)
+  
+When you're want to using clitools under OSX, you could use homebrew, an excellent package manager
+to easily install the above mentioned requirements.
 
 
 ## Install clitools

Documentation/USAGE-DOCKER.md

@@ -4,7 +4,7 @@
 
 ## Docker creation
 
-You can easly create new docker instances (from my or a custom docker boilerplate) also with code intalization
+You can easily create new docker instances (from my or a custom docker boilerplate) also with code initialization
 and Makefile running.
 
 ```bash
@@ -32,8 +32,8 @@ ct docker:create foobar --code=git... --make=build --up
 
 ## Docker startup
 
-The `docker:up` command will search the `docker-compose.yml` in the current parent directroy tree and
-execute `docker-compose` from this directroy - you don't have to change the current directroy.
+The `docker:up` command will search the `docker-compose.yml` in the current parent directory tree and
+execute `docker-compose` from this directory - you don't have to change the current directory.
 
 Also the previous docker instance will be shut down to avoid port conflicts.
 
@@ -45,7 +45,7 @@ ct docker:up
 ## Custom docker commands
 
 As `docker:up` the `docker:compose` will search the `docker-compose.yml` and will execute your command
-from this directroy.
+from this directory.
 
 ```bash
 # Stop docker instance
@@ -86,7 +86,7 @@ ct docker:exec ps
 
 You can define a common CLI script entrypoint with the environment variable CLI_SCRIPT in your docker containers.
 The environment variable will be read by `ct docker:cli` and will be executed - you don't have to jump
-into your containers, you can start your CLI_SCRIPTs from the outide.
+into your containers, you can start your CLI_SCRIPTs from the outside.
 
 ```bash
 # Execute predefined cli command with argument "help" in "main" container
@@ -110,7 +110,7 @@ ct docker:sniff mysql
 ```
 
 ## Docker cleanup
-Docker currently doesn't cleanup orphaned images or volumes so you have to cleanup your system regulary to get free disk space
+Docker currently doesn't cleanup orphaned images or volumes so you have to cleanup your system regularly to get free disk space
 
 ```bash
 ct docker:cleanup

Documentation/USAGE-MYSQL.md

@@ -17,7 +17,7 @@ ct mysql:list
 
 # Debugging
 
-The `ct mysql:querylog` and `ct mysql:slowlog` provides a convinent way to access the general query log 
+The `ct mysql:querylog` and `ct mysql:slowlog` provides a convenient way to access the general query log 
 and the slow log.
 
 In the query log you can see all queries send and executed by the MySQL database.
@@ -67,7 +67,7 @@ Also the compression is automatically detected by file mime type.
 ct mysql:restore typo3 dump.sql
 ```
 
-# Datbase charset conversion
+# Database charset conversion
 
 ```bash
 # Convert database to UTF8

Documentation/USAGE-PHP.md

@@ -4,7 +4,7 @@
 
 ## Composer (auto searching in path tree)
 
-Because you always need to jump into `composer.json` directroy `ct php:composer` will do this for you
+Because you always need to jump into `composer.json` directory `ct php:composer` will do this for you
 
 ```bash
 # Run composer install task

Documentation/USAGE-SYNC.md

@@ -69,7 +69,7 @@ ct share:restore --rsync
 
 With `sync:deploy` you can push your files to your production servers.
 Please keep in mind that this feature is just an wrapped rsync and should only be
-the simplest solution for deployment. For more advanced or centralized deployemnt try
+the simplest solution for deployment. For more advanced or centralized deployment try
 solutions build on Jenkis, Ansible and others.
 
 ```bash
@@ -80,9 +80,28 @@ ct deploy
 ct deploy staging
 ```
 
+## Rsync additional options (rsync.opts)
+
+The rsync options `-rlptD --delete-after --progress --human-readable` are automatically added when using the sync
+features of clitools. In addition, it is possible to set more options by adding them via `rsync.opts` (available since
+version 2.3 of clitools). In the following example the option `--iconv=UTF8-MAC,UTF8` is added to enable rsync filename
+charset conversion between local and remote file system. You need this especially when using rsync between hosts where a
+charset conversion on filenames is necessary (see `man rsync` for further details; e.g.: you probably need this when
+you sync between mac and linux utf-8 filesystem).
+
+```
+...
+# Enable filename charset conversion where local is UTF8-MAC (Mac OSX) and remote is UTF8 (e.g. Linux)
+rsync.opts: "--iconv=UTF8-MAC,UTF8"
+...
+```
+
+If you run into problems with `--iconv` make shure you have a compatible version of rsync >= 3.0 (as already mentioned
+in the [install section](INSTALL.md) of this documentation).
+
 ## Advanced ssh options
 
-If you need some advaned ssh options (eg. other ports) use your `~/.ssh/config` configuration file:
+If you need some advanced ssh options (eg. other ports) use your `~/.ssh/config` configuration file:
 
     Host project-server
         Hostname project-server.example.com

src/app/CliTools/Console/Command/Sync/AbstractCommand.php

@@ -716,11 +716,6 @@ protected function createRsyncCommand(
             $command->addArgumentRaw($this->contextConfig->get('rsync.opts'));
         }
 
-        // Umlauts support for rsync
-        if (PhpUtility::getOsName() === 'Darwin') {
-            $command->addArgumentRaw('--iconv=UTF8-MAC,UTF8');
-        }
-
         // Add file list (external file with --include-from option)
         if (!empty($filelist)) {
             $this->rsyncAddFileList($command, $filelist);