Client Documentation
4.3. Troubleshooting¶
4.3.1. Start the client in debug mode¶
For Windows we provide the DebugSFTPPlus.bat batch file which will start the client in foreground, sending all logs to the current console:
> CD SFTPPlus_Client_Intalation_Folder
> DebugSFTPPlus.bat
Logs will be deplayed in the console
Ctrl + C twice to stop the client
When asked to `Terminate batch job? (Y/N)` answer 'N'.
Note
Make sure that DebugSFTPPlus.bat is execute by an account with similar privilege as the account under which SFTPPlus Client service is executed. Especially make sure that the account has privileges to read the configuration files and write the message.conf and message.log file.
On Linux and Unix, use the following command to start the client in debug mode:
$ cd $SFTPPLUS_INSTALL_FOLDER
$ ./rc.SFTPPlus debug
Ctrl+C to stop
4.3.2. Manually releasing locks¶
SFTPPlus Client uses operating system’s semaphores to prevent multiple instances conflicts from handling the same files. If SFTPPlus client is forced to quit it might not had time to release the semaphores so semaphores will remain locked, preventing the initial instance from regaining access to them. In this case, users are required to manually issue the free command to release the locks.
The free command can be invoked by passing the free argument to the SFTPPlus.rexx script:
$ cd $SFTPPLUS_INSTALL_FOLDER
$ export SHLIB_PATH=`pwd`/lib
$ ./bin/regina ./SFTPPlus.rexx free
Since version 1.5.2, the rc.SFTPPlus also provides a free command that can be executed using:
$ cd $SFTPPLUS_INSTALL_FOLDER
$ ./rc.SFTPPlus free
In some rare circumstances, the SFTPPlus client can loss all control over the created semaphores and users are require to manually release the semaphore locks using external tools.
To list all semaphores active in the operating system, use the following command:
$ ipcs
You will get a list of various semaphores, shared memory and other inter process communications mechanism provided by the operating system.
Look for the IDs associated with the account used for running the SFTPPlus Client and manually release those locks. To release the locks, use the following command, where SEMAPHORE_ID is the ID obtained from running ipcs. Run this command for all active semaphores associated with SFTPPlus client account:
$ ipcrm -S SEMAPHORE_ID