usage.rst 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. Usage
  2. =====
  3. .. index:: usage, client sync usage
  4. To start ownCloud Client, click on the desktop icon or start it from the
  5. application menu. In the system tray, an ownCloud icon appears.
  6. .. index:: start application
  7. A left click on the tray icon open a status dialog which gives an overview on
  8. the configured sync folders and allows to add and remove more sync folder
  9. connections as well as pausing a sync connection.
  10. A right click on the tray icon gives other configuration options.
  11. Command line switches
  12. ---------------------
  13. .. index:: command line switches, command line, options, parameters
  14. ownCloud Client supports the following command line switches:
  15. +--------------------------+------------------------------------------------+
  16. | Switch | Action |
  17. +==========================+================================================+
  18. | ``--logwindow`` | open a window to show log output at startup. |
  19. +--------------------------+------------------------------------------------+
  20. | ``--logfile <filename>`` | write log output to file. |
  21. +--------------------------+------------------------------------------------+
  22. | ``--flushlog`` | flush the log file after every write. |
  23. +--------------------------+------------------------------------------------+
  24. Config File
  25. -----------
  26. .. index:: config file
  27. ownCloud Client reads a configuration file which on Linux can be found at ``$HOME/.local/share/data/ownCloud/owncloud.cfg``
  28. .. todo:: Windows, Mac?
  29. It contains settings in the ini file format known from Windows.
  30. .. note:: Changes here should be done carefully as wrong settings can cause disfunctionality.
  31. These are config settings that may be changed:
  32. +---------------------------+-----------+--------------+-----------+-----------------------------------------------------+
  33. | Setting | Data Type | Unit | Default | Description |
  34. +===========================+===========+==============+===========+=====================================================+
  35. | ``remotePollinterval`` | integer | milliseconds | ``30000`` | Poll time for the remote repository |
  36. +---------------------------+-----------+--------------+-----------+-----------------------------------------------------+
  37. | ``localPollinterval`` | integer | milliseconds | ``10000`` | Poll time for local repository |
  38. +---------------------------+-----------+--------------+-----------+-----------------------------------------------------+
  39. | ``PollTimerExceedFactor`` | integer | n/a | ``10`` | Poll Timer Exceed Factor |
  40. +---------------------------+-----------+--------------+-----------+-----------------------------------------------------+
  41. | ``maxLogLines`` | integer | lines | ``20000`` | Maximum count of log lines shown in the log window |
  42. +---------------------------+-----------+--------------+-----------+-----------------------------------------------------+
  43. * ``remotePollinterval`` is for systems which have notify for local file system changes (Linux only currently)
  44. this is the frequency it polls for remote changes. The following two values are ignored.
  45. * ``localPollinterval`` is for systems which poll the local file system (currently Win and Mac) this is the
  46. frequency they poll locally. The ``remotePollInterval`` is ignored on these systems.
  47. * ``PollTimerExceedFactor`` sets the exceed factor is the factor after which a remote poll is done. That means the effective
  48. frequency for remote poll is ``localPollInterval * pollTimerExceedFactor``.