From 0e6e614318a5cf8148870d70a6579c74f595ea2e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sandro=20Knau=C3=9F?= Date: Mon, 4 Feb 2013 16:55:50 +0100 Subject: [PATCH 1/8] adding --monoicons option to usage.rst --- doc/usage.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/usage.rst b/doc/usage.rst index cef8404da9..cd4424a973 100644 --- a/doc/usage.rst +++ b/doc/usage.rst @@ -30,6 +30,9 @@ ownCloud Client supports the following command line switches: +--------------------------+------------------------------------------------+ | ``--flushlog`` | flush the log file after every write. | +--------------------------+------------------------------------------------+ +| ``--monoicons`` | Use black/white pictograms for systray. | ++--------------------------+------------------------------------------------+ + Config File ----------- From 7ef92748ea4c707b6f97f09412a05fd30ab614d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sandro=20Knau=C3=9F?= Date: Mon, 4 Feb 2013 16:56:39 +0100 Subject: [PATCH 2/8] adding manpages for mirall and owncloud --- doc/asciidoc.conf | 9 +++++ doc/makeman.sh | 9 +++++ doc/mirall.1.txt | 92 ++++++++++++++++++++++++++++++++++++++++++++++ doc/owncloud.1.txt | 91 +++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 201 insertions(+) create mode 100644 doc/asciidoc.conf create mode 100755 doc/makeman.sh create mode 100644 doc/mirall.1.txt create mode 100644 doc/owncloud.1.txt diff --git a/doc/asciidoc.conf b/doc/asciidoc.conf new file mode 100644 index 0000000000..a0ded8553e --- /dev/null +++ b/doc/asciidoc.conf @@ -0,0 +1,9 @@ +# +# Customization for owncloud documentation. +# +[specialwords] +ifndef::doctype-manpage[] +emphasizedwords=(?u)\\?\bownCloud\b +monospacedwords=(?u)\\?\bowncloud\(1\) +monospacedwords=(?u)\\?\bmirall\(1\) +endif::doctype-manpage[] diff --git a/doc/makeman.sh b/doc/makeman.sh new file mode 100755 index 0000000000..913d0f01e3 --- /dev/null +++ b/doc/makeman.sh @@ -0,0 +1,9 @@ +#!/bin/bash +# Last Change: 2008-07-03 11:08:54 + +for f in $@; do + test "${f##*/}" = "CMakeLists.txt" && continue + echo -e "\e[32mCreating manpage ${f%.*}\e[0m" + a2x --doctype=manpage --format=manpage $f + rm -f ${f%.*}.xml +done diff --git a/doc/mirall.1.txt b/doc/mirall.1.txt new file mode 100644 index 0000000000..71a4b59ced --- /dev/null +++ b/doc/mirall.1.txt @@ -0,0 +1,92 @@ +mirall(1) +======== + +NAME +---- + +mirall - File synchronisation desktop utility. + + +SYNOPSIS +-------- + +*mirall* ['OPTION'...] + + +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 clickck on the desktoop icon or start from the +application menu. After starting an ownCloud icon appears in the system tray. + + +OPTIONS +------- + +*--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. + +*--help*:: + Print the help list + + +Config File +----------- + +ownCloud Client reads a configuration file which on Linux can be found at +'$HOME/.local/share/data/ownCloud/owncloud.cfg' + +On Windows and Mac, it can be found in +'\Users\\AppData\Local\ownCloud\owncloud.cfg' + +*Changes here should be done carefully as wrong settings can cause disfunctionality.* + + +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. + + +BUGS +---- + +Please report bugs at 'https://github.com/owncloud/core/issues'. + + +SEE ALSO +-------- + +*csync*(1), *owncloud*(1) + + +AUTHORS +------- + +The ownCloud developers + + +COPYING +------- +Copyright (c) 2013 the ownCloud developers. Free use of this software is granted under the terms of the GNU General Public License (GPL2+). + diff --git a/doc/owncloud.1.txt b/doc/owncloud.1.txt new file mode 100644 index 0000000000..14f55d88f4 --- /dev/null +++ b/doc/owncloud.1.txt @@ -0,0 +1,91 @@ +owncloud(1) +=========== + +NAME +---- + +owncloud - File synchronisation desktop utility. + + +SYNOPSIS +-------- + +*owncloud* ['OPTION'...] + + +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 clickck on the desktoop icon or start from the +application menu. After starting an ownCloud icon appears in the system tray. + + +OPTIONS +------- + +*--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. + +*--help*:: + Print the help list + + +Config File +----------- + +ownCloud Client reads a configuration file which on Linux can be found at +'$HOME/.local/share/data/ownCloud/owncloud.cfg' + +On Windows and Mac, it can be found in +'\Users\\AppData\Local\ownCloud\owncloud.cfg' + +*Changes here should be done carefully as wrong settings can cause disfunctionality.* + + +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. + + +BUGS +---- + +Please report bugs at 'https://github.com/owncloud/core/issues'. + + +SEE ALSO +-------- + +*csync*(1), *mirall*(1) + + +AUTHORS +------- + +The ownCloud developers + + +COPYING +------- +Copyright (c) 2013 the ownCloud developers. Free use of this software is granted under the terms of the GNU General Public License (GPL2+). From 279bb47ab4797d3abe0227863f025d8c09acbccf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sandro=20Knau=C3=9F?= Date: Mon, 4 Feb 2013 17:36:56 +0100 Subject: [PATCH 3/8] add creating manpages to CMakeLists --- doc/CMakeLists.txt | 11 ++++++++++- doc/makeman.sh | 8 +++++++- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 084eb167a0..f135e0e6aa 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -43,11 +43,20 @@ if(SPHINX_FOUND) -d ${SPHINX_CACHE_DIR} ${CMAKE_CURRENT_SOURCE_DIR} ${SPHINX_HTML_DIR} ) - add_custom_target( doc-man ${SPHINX_EXECUTABLE} + add_custom_target( doc-sphinx-man ${SPHINX_EXECUTABLE} -q -c . -b man -d ${SPHINX_CACHE_DIR} ${CMAKE_CURRENT_SOURCE_DIR} ${SPHINX_MAN_DIR} ) + + file(GLOB _manpages *.[0-9].txt) + add_custom_target(doc-man + COMMAND + MAN_DIR=${SPHINX_MAN_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/makeman.sh ${_manpages} + WORKING_DIRECTORY + ${CMAKE_CURRENT_SOURCE_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/makeman.sh b/doc/makeman.sh index 913d0f01e3..52917cce47 100755 --- a/doc/makeman.sh +++ b/doc/makeman.sh @@ -1,9 +1,15 @@ #!/bin/bash # Last Change: 2008-07-03 11:08:54 +if [ "x${MAN_DIR}" == 'x' ]; then + MAN_DIR=`pwd` +fi + +mkdir -p ${MAN_DIR} + for f in $@; do test "${f##*/}" = "CMakeLists.txt" && continue echo -e "\e[32mCreating manpage ${f%.*}\e[0m" - a2x --doctype=manpage --format=manpage $f + a2x --doctype=manpage --format=manpage $f --destination-dir ${MAN_DIR} rm -f ${f%.*}.xml done From 1a907f23f006d7711385396ef789508c06948997 Mon Sep 17 00:00:00 2001 From: hefee Date: Sat, 9 Feb 2013 10:05:45 +0100 Subject: [PATCH 4/8] moving generation of manpages to sphinx --HG-- rename : doc/mirall.1.txt => doc/mirall.1.rst rename : doc/owncloud.1.txt => doc/owncloud.1.rst --- doc/conf.py.in | 6 ++- doc/mirall.1.rst | 68 ++++++++++++++++++++++++++++++++++ doc/mirall.1.txt | 92 ---------------------------------------------- doc/owncloud.1.rst | 69 ++++++++++++++++++++++++++++++++++ doc/owncloud.1.txt | 91 --------------------------------------------- 5 files changed, 141 insertions(+), 185 deletions(-) create mode 100644 doc/mirall.1.rst delete mode 100644 doc/mirall.1.txt create mode 100644 doc/owncloud.1.rst delete mode 100644 doc/owncloud.1.txt 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/mirall.1.rst b/doc/mirall.1.rst new file mode 100644 index 0000000000..7be82a84d6 --- /dev/null +++ b/doc/mirall.1.rst @@ -0,0 +1,68 @@ +mirall(1) +--------- + +SYNOPSIS +======== + +*mirall* ['OPTION'...] + + +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 clickck on the desktoop icon or start from the +application menu. After starting an ownCloud icon appears in the system tray. + + +OPTIONS +======= + + --logwindow + Open a window to show log output at startup. + --logfile `` + 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. + + +Config File +=========== + +ownCloud Client reads a configuration file which on Linux can be found at +`$HOME/.local/share/data/ownCloud/owncloud.cfg` + +On Windows and Mac, it can be found in +`\\Users\\\\AppData\\Local\\ownCloud\\owncloud.cfg` + +*Changes here should be done carefully as wrong settings can cause disfunctionality.* + + +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. + + +BUGS +==== + +Please report bugs at https://github.com/owncloud/core/issues. + + +SEE ALSO +======== +`csync(1)`, `mirall(1)` + diff --git a/doc/mirall.1.txt b/doc/mirall.1.txt deleted file mode 100644 index 71a4b59ced..0000000000 --- a/doc/mirall.1.txt +++ /dev/null @@ -1,92 +0,0 @@ -mirall(1) -======== - -NAME ----- - -mirall - File synchronisation desktop utility. - - -SYNOPSIS --------- - -*mirall* ['OPTION'...] - - -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 clickck on the desktoop icon or start from the -application menu. After starting an ownCloud icon appears in the system tray. - - -OPTIONS -------- - -*--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. - -*--help*:: - Print the help list - - -Config File ------------ - -ownCloud Client reads a configuration file which on Linux can be found at -'$HOME/.local/share/data/ownCloud/owncloud.cfg' - -On Windows and Mac, it can be found in -'\Users\\AppData\Local\ownCloud\owncloud.cfg' - -*Changes here should be done carefully as wrong settings can cause disfunctionality.* - - -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. - - -BUGS ----- - -Please report bugs at 'https://github.com/owncloud/core/issues'. - - -SEE ALSO --------- - -*csync*(1), *owncloud*(1) - - -AUTHORS -------- - -The ownCloud developers - - -COPYING -------- -Copyright (c) 2013 the ownCloud developers. Free use of this software is granted under the terms of the GNU General Public License (GPL2+). - diff --git a/doc/owncloud.1.rst b/doc/owncloud.1.rst new file mode 100644 index 0000000000..d8fb39dbe5 --- /dev/null +++ b/doc/owncloud.1.rst @@ -0,0 +1,69 @@ +owncloud(1) +----------- + + +SYNOPSIS +======== + *owncloud* ['OPTION'...] + + +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 clickck on the desktoop icon or start from the + application menu. After starting an ownCloud icon appears in the system tray. + + + + +OPTIONS +======= + + --logwindow + Open a window to show log output at startup. + --logfile `` + 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. + + +Config File +=========== + +ownCloud Client reads a configuration file which on Linux can be found at +`$HOME/.local/share/data/ownCloud/owncloud.cfg` + +On Windows and Mac, it can be found in +`\\Users\\\\AppData\\Local\\ownCloud\\owncloud.cfg` + +*Changes here should be done carefully as wrong settings can cause disfunctionality.* + + +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. + + +BUGS +==== + +Please report bugs at https://github.com/owncloud/core/issues. + + +SEE ALSO +======== + `csync(1)`, `mirall(1)` + diff --git a/doc/owncloud.1.txt b/doc/owncloud.1.txt deleted file mode 100644 index 14f55d88f4..0000000000 --- a/doc/owncloud.1.txt +++ /dev/null @@ -1,91 +0,0 @@ -owncloud(1) -=========== - -NAME ----- - -owncloud - File synchronisation desktop utility. - - -SYNOPSIS --------- - -*owncloud* ['OPTION'...] - - -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 clickck on the desktoop icon or start from the -application menu. After starting an ownCloud icon appears in the system tray. - - -OPTIONS -------- - -*--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. - -*--help*:: - Print the help list - - -Config File ------------ - -ownCloud Client reads a configuration file which on Linux can be found at -'$HOME/.local/share/data/ownCloud/owncloud.cfg' - -On Windows and Mac, it can be found in -'\Users\\AppData\Local\ownCloud\owncloud.cfg' - -*Changes here should be done carefully as wrong settings can cause disfunctionality.* - - -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. - - -BUGS ----- - -Please report bugs at 'https://github.com/owncloud/core/issues'. - - -SEE ALSO --------- - -*csync*(1), *mirall*(1) - - -AUTHORS -------- - -The ownCloud developers - - -COPYING -------- -Copyright (c) 2013 the ownCloud developers. Free use of this software is granted under the terms of the GNU General Public License (GPL2+). From 028521314063b36fddb8a3d15c86d0a4583624f3 Mon Sep 17 00:00:00 2001 From: hefee Date: Sat, 9 Feb 2013 10:10:23 +0100 Subject: [PATCH 5/8] removing asciidoc, now creating manpages via sphinx again --- doc/CMakeLists.txt | 10 +--------- doc/asciidoc.conf | 9 --------- doc/makeman.sh | 15 --------------- 3 files changed, 1 insertion(+), 33 deletions(-) delete mode 100644 doc/asciidoc.conf delete mode 100755 doc/makeman.sh diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index f135e0e6aa..e287dee655 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -43,20 +43,12 @@ if(SPHINX_FOUND) -d ${SPHINX_CACHE_DIR} ${CMAKE_CURRENT_SOURCE_DIR} ${SPHINX_HTML_DIR} ) - add_custom_target( doc-sphinx-man ${SPHINX_EXECUTABLE} + add_custom_target( doc-man ${SPHINX_EXECUTABLE} -q -c . -b man -d ${SPHINX_CACHE_DIR} ${CMAKE_CURRENT_SOURCE_DIR} ${SPHINX_MAN_DIR} ) - file(GLOB _manpages *.[0-9].txt) - add_custom_target(doc-man - COMMAND - MAN_DIR=${SPHINX_MAN_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/makeman.sh ${_manpages} - WORKING_DIRECTORY - ${CMAKE_CURRENT_SOURCE_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/asciidoc.conf b/doc/asciidoc.conf deleted file mode 100644 index a0ded8553e..0000000000 --- a/doc/asciidoc.conf +++ /dev/null @@ -1,9 +0,0 @@ -# -# Customization for owncloud documentation. -# -[specialwords] -ifndef::doctype-manpage[] -emphasizedwords=(?u)\\?\bownCloud\b -monospacedwords=(?u)\\?\bowncloud\(1\) -monospacedwords=(?u)\\?\bmirall\(1\) -endif::doctype-manpage[] diff --git a/doc/makeman.sh b/doc/makeman.sh deleted file mode 100755 index 52917cce47..0000000000 --- a/doc/makeman.sh +++ /dev/null @@ -1,15 +0,0 @@ -#!/bin/bash -# Last Change: 2008-07-03 11:08:54 - -if [ "x${MAN_DIR}" == 'x' ]; then - MAN_DIR=`pwd` -fi - -mkdir -p ${MAN_DIR} - -for f in $@; do - test "${f##*/}" = "CMakeLists.txt" && continue - echo -e "\e[32mCreating manpage ${f%.*}\e[0m" - a2x --doctype=manpage --format=manpage $f --destination-dir ${MAN_DIR} - rm -f ${f%.*}.xml -done From e1f404a01193907c10f02c7f23541b6d34abe2ab Mon Sep 17 00:00:00 2001 From: hefee Date: Sat, 9 Feb 2013 10:30:56 +0100 Subject: [PATCH 6/8] adding maclocation --- doc/mirall.1.rst | 8 ++++++-- doc/owncloud.1.rst | 8 ++++++-- doc/usage.rst | 6 +++++- 3 files changed, 17 insertions(+), 5 deletions(-) diff --git a/doc/mirall.1.rst b/doc/mirall.1.rst index 7be82a84d6..ca07becf7a 100644 --- a/doc/mirall.1.rst +++ b/doc/mirall.1.rst @@ -40,11 +40,15 @@ Config File ownCloud Client reads a configuration file which on Linux can be found at `$HOME/.local/share/data/ownCloud/owncloud.cfg` -On Windows and Mac, it can be found in -`\\Users\\\\AppData\\Local\\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//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: diff --git a/doc/owncloud.1.rst b/doc/owncloud.1.rst index d8fb39dbe5..13ecdf1e1c 100644 --- a/doc/owncloud.1.rst +++ b/doc/owncloud.1.rst @@ -41,11 +41,15 @@ Config File ownCloud Client reads a configuration file which on Linux can be found at `$HOME/.local/share/data/ownCloud/owncloud.cfg` -On Windows and Mac, it can be found in -`\\Users\\\\AppData\\Local\\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//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: diff --git a/doc/usage.rst b/doc/usage.rst index ac901968f2..043d4d9188 100644 --- a/doc/usage.rst +++ b/doc/usage.rst @@ -40,7 +40,11 @@ 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? +.. note:: The new version is less precise in this regard. + +On Mac, it can be found in ``$HOME/Library/Application Support/ownCloud`` or ``/Users//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. From 0ea16c04cc6ef55656f5c62ee8b842bf6c1ab3ef Mon Sep 17 00:00:00 2001 From: hefee Date: Sat, 9 Feb 2013 12:23:32 +0100 Subject: [PATCH 7/8] 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 --- doc/conffile.rst | 31 +++++++++++++++++++++++++ doc/mirall.1.rst | 42 ++++------------------------------ doc/options.rst | 15 +++++++++++++ doc/owncloud.1.rst | 56 +++++++++------------------------------------- doc/usage.rst | 51 ++++------------------------------------- 5 files changed, 64 insertions(+), 131 deletions(-) create mode 100644 doc/conffile.rst create mode 100644 doc/options.rst 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 index ca07becf7a..ca9c6ee7c7 100644 --- a/doc/mirall.1.rst +++ b/doc/mirall.1.rst @@ -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 `` - 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//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 ==== 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 index 13ecdf1e1c..4ad0648ed4 100644 --- a/doc/owncloud.1.rst +++ b/doc/owncloud.1.rst @@ -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 `` - 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//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 ==== diff --git a/doc/usage.rst b/doc/usage.rst index 043d4d9188..8752941526 100644 --- a/doc/usage.rst +++ b/doc/usage.rst @@ -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 `` | 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//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 From 17901e7bc77ce6a1d152534e2e6d84a4b5d2b034 Mon Sep 17 00:00:00 2001 From: hefee Date: Sat, 9 Feb 2013 12:28:43 +0100 Subject: [PATCH 8/8] fixing typo in mirall.1.rst --- doc/mirall.1.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/mirall.1.rst b/doc/mirall.1.rst index ca9c6ee7c7..183c68bec5 100644 --- a/doc/mirall.1.rst +++ b/doc/mirall.1.rst @@ -15,7 +15,7 @@ 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 +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