mirror of
https://github.com/nextcloud/desktop.git
synced 2024-11-22 13:05:51 +03:00
moving description of config file and client optinos to own files.
* split usage to three files: usage, conffile, options * fixing minor typos in mirall.1.rst and owncloud1.rst * owncloud.1 uses include conffile, options * mirall.1 uses include conffile, options * Fixes: #183
This commit is contained in:
hefee
parent
e1f404a011
commit
0ea16c04cc
5 changed files with 64 additions and 131 deletions
31
doc/conffile.rst
Normal file
31
doc/conffile.rst
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
ownCloud Client reads a configuration file.
|
||||
|
||||
On Linux it can be found in:
|
||||
``$HOME/.local/share/data/ownCloud/owncloud.cfg``
|
||||
|
||||
On Windows it can be found in:
|
||||
``%LOCALAPPDATA%\ownCloud\owncloud.cfg``
|
||||
|
||||
On Mac it can be found in:
|
||||
``$HOME/Library/Application Support/ownCloud``
|
||||
|
||||
|
||||
It contains settings in the ini file format known from Windows.
|
||||
|
||||
.. note:: Changes here should be done carefully as wrong settings can cause disfunctionality.
|
||||
|
||||
.. note:: Changes may be overwritten by using ownCloud's configuration dialog.
|
||||
|
||||
.. note:: The new version is less precise in this regard.
|
||||
|
||||
These are config settings that may be changed:
|
||||
|
||||
``remotePollinterval`` (default: ``30000``)
|
||||
Poll time for the remote repository in milliseconds
|
||||
|
||||
``maxLogLines`` (default: ``20000``)
|
||||
Maximum count of log lines shown in the log window
|
||||
|
||||
``remotePollinterval``
|
||||
The frequency used for polling for remote changes on the ownCloud Server.
|
||||
|
||||
|
|
@ -4,7 +4,7 @@ mirall(1)
|
|||
SYNOPSIS
|
||||
========
|
||||
|
||||
*mirall* ['OPTION'...]
|
||||
*mirall* [`OPTIONS`...]
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
|
|
@ -18,47 +18,13 @@ using this desktop sync clients.
|
|||
Normally you start the client by clickck on the desktoop icon or start from the
|
||||
application menu. After starting an ownCloud icon appears in the system tray.
|
||||
|
||||
|
||||
OPTIONS
|
||||
Options
|
||||
=======
|
||||
|
||||
--logwindow
|
||||
Open a window to show log output at startup.
|
||||
--logfile `<filename>`
|
||||
write log output to file.
|
||||
--flushlog
|
||||
flush the log file after every write.
|
||||
--monoicon
|
||||
Use black/white pictograms for systray.
|
||||
--help
|
||||
Print the help list.
|
||||
|
||||
.. include:: options.rst
|
||||
|
||||
Config File
|
||||
===========
|
||||
|
||||
ownCloud Client reads a configuration file which on Linux can be found at
|
||||
`$HOME/.local/share/data/ownCloud/owncloud.cfg`
|
||||
|
||||
On Windows it can be found in:
|
||||
`%LOCALAPPDATA%\\ownCloud\\owncloud.cfg`
|
||||
|
||||
On Mac it is located in:
|
||||
`$HOME/Library/Application Support/ownCloud` or `/Users/<user>/Library/Application Support/ownCloud`
|
||||
|
||||
*Changes here should be done carefully as wrong settings can cause disfunctionality.*
|
||||
|
||||
*Changes may be overwritten by using ownCloud's configuration dialog.*
|
||||
|
||||
These are config settings that may be changed:
|
||||
|
||||
remotePollinterval
|
||||
Poll time for the remote repository in milliseconds (default 30000)
|
||||
maxLogLines
|
||||
Maximum count of log lines shown in the log window (default 20000)
|
||||
remotePollinterval
|
||||
The frequency used for polling for remote changes on the ownCloud Server.
|
||||
|
||||
.. include:: conffile.rst
|
||||
|
||||
BUGS
|
||||
====
|
||||
|
|
|
|||
15
doc/options.rst
Normal file
15
doc/options.rst
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
ownCloud Client supports the following command line switches:
|
||||
|
||||
``--logwindow``
|
||||
open a window to show log output at startup.
|
||||
|
||||
``--logfile`` `<filename>`
|
||||
write log output to file.
|
||||
|
||||
``--flushlog``
|
||||
flush the log file after every write.
|
||||
|
||||
``--monoicons``
|
||||
Use black/white pictograms for systray.
|
||||
|
||||
|
||||
|
|
@ -4,62 +4,26 @@ owncloud(1)
|
|||
|
||||
SYNOPSIS
|
||||
========
|
||||
*owncloud* ['OPTION'...]
|
||||
*owncloud* [`OPTIONS`...]
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
===========
|
||||
owncloud is a file synchronisation desktop utility it is based on mirall.
|
||||
It synchronizes files on your local machine with an ownCloud Server. If you
|
||||
make a change to the files on one computer, it will flow across the others
|
||||
using this desktop sync clients.
|
||||
owncloud is a file synchronisation desktop utility it is based on mirall.
|
||||
It synchronizes files on your local machine with an ownCloud Server. If you
|
||||
make a change to the files on one computer, it will flow across the others
|
||||
using this desktop sync clients.
|
||||
|
||||
Normally you start the client by clickck on the desktoop icon or start from the
|
||||
application menu. After starting an ownCloud icon appears in the system tray.
|
||||
Normally you start the client by click on the desktop icon or start from the
|
||||
application menu. After starting an ownCloud icon appears in the system tray.
|
||||
|
||||
|
||||
|
||||
|
||||
OPTIONS
|
||||
Options
|
||||
=======
|
||||
|
||||
--logwindow
|
||||
Open a window to show log output at startup.
|
||||
--logfile `<filename>`
|
||||
write log output to file.
|
||||
--flushlog
|
||||
flush the log file after every write.
|
||||
--monoicon
|
||||
Use black/white pictograms for systray.
|
||||
--help
|
||||
Print the help list.
|
||||
|
||||
.. include:: options.rst
|
||||
|
||||
Config File
|
||||
===========
|
||||
|
||||
ownCloud Client reads a configuration file which on Linux can be found at
|
||||
`$HOME/.local/share/data/ownCloud/owncloud.cfg`
|
||||
|
||||
On Windows it can be found in:
|
||||
`%LOCALAPPDATA%\\ownCloud\\owncloud.cfg`
|
||||
|
||||
On Mac it is located in:
|
||||
`$HOME/Library/Application Support/ownCloud` or `/Users/<user>/Library/Application Support/ownCloud`
|
||||
|
||||
*Changes here should be done carefully as wrong settings can cause disfunctionality.*
|
||||
|
||||
*Changes may be overwritten by using ownCloud's configuration dialog.*
|
||||
|
||||
These are config settings that may be changed:
|
||||
|
||||
remotePollinterval
|
||||
Poll time for the remote repository in milliseconds (default 30000)
|
||||
maxLogLines
|
||||
Maximum count of log lines shown in the log window (default 20000)
|
||||
remotePollinterval
|
||||
The frequency used for polling for remote changes on the ownCloud Server.
|
||||
|
||||
.. include:: conffile.rst
|
||||
|
||||
BUGS
|
||||
====
|
||||
|
|
|
|||
|
|
@ -13,55 +13,12 @@ connections as well as pausing a sync connection.
|
|||
|
||||
A right click on the tray icon gives other configuration options.
|
||||
|
||||
|
||||
Command line switches
|
||||
---------------------
|
||||
Options
|
||||
-------
|
||||
.. index:: command line switches, command line, options, parameters
|
||||
|
||||
|
||||
ownCloud Client supports the following command line switches:
|
||||
|
||||
+--------------------------+------------------------------------------------+
|
||||
| Switch | Action |
|
||||
+==========================+================================================+
|
||||
| ``--logwindow`` | open a window to show log output at startup. |
|
||||
+--------------------------+------------------------------------------------+
|
||||
| ``--logfile <filename>`` | write log output to file. |
|
||||
+--------------------------+------------------------------------------------+
|
||||
| ``--flushlog`` | flush the log file after every write. |
|
||||
+--------------------------+------------------------------------------------+
|
||||
| ``--monoicons`` | Use black/white pictograms for systray. |
|
||||
+--------------------------+------------------------------------------------+
|
||||
|
||||
.. include:: options.rst
|
||||
|
||||
Config File
|
||||
-----------
|
||||
.. index:: config file
|
||||
|
||||
ownCloud Client reads a configuration file which on Linux can be found at ``$HOME/.local/share/data/ownCloud/owncloud.cfg``
|
||||
On Windows, it can be found in ``%LOCALAPPDATA%\ownCloud\owncloud.cfg``
|
||||
.. note:: The new version is less precise in this regard.
|
||||
|
||||
On Mac, it can be found in ``$HOME/Library/Application Support/ownCloud`` or ``/Users/<user>/Library/Application Support/ownCloud``
|
||||
|
||||
|
||||
It contains settings in the ini file format known from Windows.
|
||||
|
||||
.. note:: Changes here should be done carefully as wrong settings can cause disfunctionality.
|
||||
|
||||
.. note:: Changes may be overwritten by using ownCloud's configuration dialog.
|
||||
|
||||
|
||||
These are config settings that may be changed:
|
||||
|
||||
+---------------------------+-----------+--------------+-----------+-----------------------------------------------------+
|
||||
| Setting | Data Type | Unit | Default | Description |
|
||||
+===========================+===========+==============+===========+=====================================================+
|
||||
| ``remotePollinterval`` | integer | milliseconds | ``30000`` | Poll time for the remote repository |
|
||||
+---------------------------+-----------+--------------+-----------+-----------------------------------------------------+
|
||||
| ``maxLogLines`` | integer | lines | ``20000`` | Maximum count of log lines shown in the log window |
|
||||
+---------------------------+-----------+--------------+-----------+-----------------------------------------------------+
|
||||
|
||||
* ``remotePollinterval`` The frequency used for polling for remote changes on
|
||||
the ownCloud Server.
|
||||
|
||||
.. include:: conffile.rst
|
||||
|
|
|
|||
Loading…
Reference in a new issue