From d8fe1bdda8cbe41fb8014f532599cd69bb5267c7 Mon Sep 17 00:00:00 2001 From: hierynomus Date: Tue, 5 Feb 2013 11:04:14 +0100 Subject: [PATCH] Included documentation for #52 --- README.md | 92 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 91 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7e377b5b..44cb7d5f 100644 --- a/README.md +++ b/README.md @@ -197,7 +197,7 @@ The SSH protocol implementation of Overthere defines a number of additional conn sudoCommandPrefix - The command to prefix to the command to be executed to execute it as sudoUsername. The string {0} is replaced with the vaulue of sudoUsername. The default value is sudo -u {0}. + The command to prefix to the command to be executed to execute it as sudoUsername. The string {0} is replaced with the value of sudoUsername. The default value is sudo -u {0}.
N.B.: This connection option is only applicable for the SUDO and INTERACTIVE_SUDO connection types. @@ -235,6 +235,96 @@ The SSH protocol implementation of Overthere defines a number of additional conn openShellBeforeExecute If set to true, Overthere will open and close a shell immediately before executing a command on an ssh host. This is useful when the connecting user does not yet have a homedir, but this is created for him on the fly on the host. A setup commonly seen when user management is done through LDAP. + + deleteDirectoryCommand + The command to be used when deleting a directory. The string {0} is replaced with the value of the path of the directory to be deleted. The default value is rmdir {0}. +
+ N.B.: This connection option is only applicable for the SCP, SUDO and INTERACTIVE_SUDO connection types. + + + deleteFileCommand + The command to be used when deleting a file. The string {0} is replaced with the value of the path of the file to be deleted. The default value is rm -f {0}. +
+ N.B.: This connection option is only applicable for the SCP, SUDO and INTERACTIVE_SUDO connection types. + + + deleteRecursivelyCommand + The command to be used when deleting a directory recursively. The string {0} is replaced with the value of the path of the directory to be deleted. The default value is rm -rf {0}. +
+ N.B.: This connection option is only applicable for the SCP, SUDO and INTERACTIVE_SUDO connection types. + + + getFileInfoCommand + The command to be used when getting the metadata of a file/directory. The string {0} is replaced with the value of the path of the file/directory. The default value is ls -ld {0}. +
+ N.B.: This connection option is only applicable for the SCP, SUDO and INTERACTIVE_SUDO connection types. + + + listFilesCommand + The command to be used when listing the contents of a directory. The string {0} is replaced with the value of the path of the directory to be listed. The default value is ls -a1 {0}. +
+ N.B.: This connection option is only applicable for the SCP, SUDO and INTERACTIVE_SUDO connection types. + + + mkdirCommand + The command to be used when creating a directory. The string {0} is replaced with the value of the path of the directory to be created. The default value is mkdir {0}. +
+ N.B.: This connection option is only applicable for the SCP, SUDO and INTERACTIVE_SUDO connection types. + + + mkdirsCommand + The command to be used when creating a directory tree. The string {0} is replaced with the value of the path of the directory tree to be created. The default value is mkdir -p {0}. +
+ N.B.: This connection option is only applicable for the SCP, SUDO and INTERACTIVE_SUDO connection types. + + + renameToCommand + The command to be used when renaming a file/directory. The string {0} is replaced with the value of the path of the file/directory to be renamed. The string {1} is replaced with the value of the new name. The default value is mv {0} {1}. +
+ N.B.: This connection option is only applicable for the SCP, SUDO and INTERACTIVE_SUDO connection types. + + + setExecutableCommand + The command to be used when making a file executable. The string {0} is replaced with the value of the path of the file/directory affected. The default value is chmod a+x {0}. +
+ N.B.: This connection option is only applicable for the SCP, SUDO and INTERACTIVE_SUDO connection types. + + + setNotExecutableCommand + The command to be used when making a file non-executable. The string {0} is replaced with the value of the path of the file/directory affected. The default value is chmod a-x {0}. +
+ N.B.: This connection option is only applicable for the SCP, SUDO and INTERACTIVE_SUDO connection types. + + + sudoTempMkdirCommand + The command to be used when creating a temporary directory as a sudo user. The directory needs to be read/writeable for both the connecting and the sudo user. The string {0} is replaced with the value of the path of the directory to be created. The default value is mkdir -m 1777 {0}. +
+ N.B.: This connection option is only applicable for the SUDO and INTERACTIVE_SUDO connection types. + + + sudoTempMkdirsCommand + The command to be used when creating a temporary directory tree as a sudo user. The directory tree needs to be read/writeable for both the connecting and the sudo user. The string {0} is replaced with the value of the path of the directory to be created. The default value is mkdir -p -m 1777 {0}. +
+ N.B.: This connection option is only applicable for the SUDO and INTERACTIVE_SUDO connection types. + + + sudoCopyFromTempFileCommand + The command to be used when copying files/directories from the connection temporary directory as the sudo user. The string {0} is replaced with the value of the path of the file/directory being copied. The string {1} is replaced with the value of the target path. The default value is cp -pr {0} {1} if ssh_sudoPreserveAttributesOnCopyFromTempFile is set to true, otherwise the default value is cp -r {0} {1}. +
+ N.B.: This connection option is only applicable for the SUDO and INTERACTIVE_SUDO connection types. + + + sudoOverrideUmaskCommand + The command to be used when setting the umask before copying a file/directory from, or after copying it to the connection temporary directory. This command ensures that the sudo user has read (and/or execute) rights for the copied file/directory. The string {0} is replaced with the value of the file/directory being copied. The default value is chmod -R go+rX {0}. +
+ N.B.: This connection option is only applicable for the SUDO and INTERACTIVE_SUDO connection types. + + + sudoCopyToTempFileCommand + The command to be used when copying files/directories to the connection temporary directory as the sudo user. The string {0} is replaced with the value of the path of the file/directory being copied. The string {1} is replaced with the value of the target path. The default value is cp -pr {0} {1} if ssh_sudoPreserveAttributesOnCopyToTempFile is set to true, otherwise the default value is cp -r {0} {1}. +
+ N.B.: This connection option is only applicable for the SUDO and INTERACTIVE_SUDO connection types. +