diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 084eb167a0..e287dee655 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -48,6 +48,7 @@ if(SPHINX_FOUND) -d ${SPHINX_CACHE_DIR} ${CMAKE_CURRENT_SOURCE_DIR} ${SPHINX_MAN_DIR} ) + ## Building CHM files requires HTML Help Workshop. Since it requires wine ## with special dependencies, it's impossible to write a cmake check for it. ## This is why doc-chm is not a dependency for doc. Instead, run diff --git a/doc/conf.py.in b/doc/conf.py.in index 00cd97350d..c8d2534ed6 100644 --- a/doc/conf.py.in +++ b/doc/conf.py.in @@ -213,12 +213,14 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'owncloud', u'ownCloud Client Manual', + ('owncloud.1', 'owncloud', u'File synchronisation desktop utility.', + [u'The ownCloud developers'], 1), + ('mirall.1', 'mirall', u'File synchronisation desktop utility.', [u'The ownCloud developers'], 1) ] # If true, show URL addresses after external links. -#man_show_urls = False +man_show_urls = True # -- Options for Texinfo output ------------------------------------------------ diff --git a/doc/conffile.rst b/doc/conffile.rst new file mode 100644 index 0000000000..9d7da4a61d --- /dev/null +++ b/doc/conffile.rst @@ -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. + diff --git a/doc/mirall.1.rst b/doc/mirall.1.rst new file mode 100644 index 0000000000..183c68bec5 --- /dev/null +++ b/doc/mirall.1.rst @@ -0,0 +1,38 @@ +mirall(1) +--------- + +SYNOPSIS +======== + +*mirall* [`OPTIONS`...] + + +DESCRIPTION +=========== + +mirall is a file synchronisation desktop utility. +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 click on the desktop icon or start from the +application menu. After starting an ownCloud icon appears in the system tray. + +Options +======= +.. include:: options.rst + +Config File +=========== +.. include:: conffile.rst + +BUGS +==== + +Please report bugs at https://github.com/owncloud/core/issues. + + +SEE ALSO +======== +`csync(1)`, `mirall(1)` + diff --git a/doc/options.rst b/doc/options.rst new file mode 100644 index 0000000000..3e3c014d09 --- /dev/null +++ b/doc/options.rst @@ -0,0 +1,15 @@ +ownCloud Client supports the following command line switches: + +``--logwindow`` + open a window to show log output at startup. + +``--logfile`` `` + write log output to file. + +``--flushlog`` + flush the log file after every write. + +``--monoicons`` + Use black/white pictograms for systray. + + diff --git a/doc/owncloud.1.rst b/doc/owncloud.1.rst new file mode 100644 index 0000000000..4ad0648ed4 --- /dev/null +++ b/doc/owncloud.1.rst @@ -0,0 +1,37 @@ +owncloud(1) +----------- + + +SYNOPSIS +======== +*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. + +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 +======= +.. include:: options.rst + +Config File +=========== +.. include:: conffile.rst + +BUGS +==== + +Please report bugs at https://github.com/owncloud/core/issues. + + +SEE ALSO +======== + `csync(1)`, `mirall(1)` + diff --git a/doc/usage.rst b/doc/usage.rst index 0670dbcf83..8752941526 100644 --- a/doc/usage.rst +++ b/doc/usage.rst @@ -13,48 +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 `` | write log output to file. | -+--------------------------+------------------------------------------------+ -| ``--flushlog`` | flush the log file after every write. | -+--------------------------+------------------------------------------------+ +.. 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`` -.. todo:: Mac? -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