Commit Graph

544 Commits

Author SHA1 Message Date
Tatsuhiro Tsujikawa
bb194f6c6b Add missing docs to EXTRA_DIST 2013-05-18 17:14:24 +09:00
Tatsuhiro Tsujikawa
93db904e48 Add reference marker to EXIT STATUS section 2013-05-18 16:37:58 +09:00
Tatsuhiro Tsujikawa
8b7bac60ec Update libaria2.rst 2013-05-18 16:35:50 +09:00
Tatsuhiro Tsujikawa
0ed4fec8a8 Update libaria2.rst 2013-05-18 16:27:13 +09:00
Tatsuhiro Tsujikawa
0adc4b795e Add gid option to Input File section 2013-05-16 23:15:23 +09:00
Tatsuhiro Tsujikawa
c7c4d46672 Add changeOption and DownloadHandle::getOption API
In aria2c.rst, define section label for "Input File" section so that
it can be referenced from other document.
2013-05-16 23:09:19 +09:00
Tatsuhiro Tsujikawa
390ad710f1 Update copyright year in aria2c.rst 2013-05-11 22:35:19 +09:00
Tatsuhiro Tsujikawa
771af11212 Update doc theme 2013-05-11 21:05:40 +09:00
Tatsuhiro Tsujikawa
e350df2d75 Add download event callback API and its example 2013-05-11 19:40:24 +09:00
Tatsuhiro Tsujikawa
01d2cb197c Fix doc 2013-05-10 00:06:50 +09:00
Tatsuhiro Tsujikawa
742f8cc822 Document theme change
Need to change ru and pt as well
2013-05-10 00:01:19 +09:00
Tatsuhiro Tsujikawa
370584a12b Update doc 2013-05-09 23:59:50 +09:00
Tatsuhiro Tsujikawa
f2c2f08585 Support @class, fix execution failure 2013-05-09 23:59:22 +09:00
Tatsuhiro Tsujikawa
ca6b46db84 Generate libaria2 API doc from aria2.h 2013-05-09 23:49:30 +09:00
Tatsuhiro Tsujikawa
9665a3491d Avoid docutils bug
Old docutils has bug which does not escape . at the start of the line,
which accidentally makes it manpage macro.
2013-04-23 21:12:28 +09:00
Tatsuhiro Tsujikawa
8604714c4e Update bash_completion 2013-04-20 23:04:11 +09:00
Tatsuhiro Tsujikawa
f326955108 Fix sphinx warnings 2013-04-15 21:18:22 +09:00
Tatsuhiro Tsujikawa
adab7ace6e Merge branch 'master' of https://github.com/gsavix/aria2 into gsavix-master 2013-04-15 21:15:12 +09:00
gilberto dos santos alves
6ced9deef8 Update aria2c.rst
appletls warnings. first create private certificate with sha-1
2013-04-14 13:52:33 -03:00
gilberto dos santos alves
ca57f82dae Update aria2c.rst
type error metalink option rst title chars (mixed ~----~~
2013-04-14 13:32:04 -03:00
ITriskTI
a3aec02fe1 Update aria2c.rst 2013-04-14 18:33:03 +03:00
Nils Maier
f9225db135 AppleTLS: Document new --rpc-certificate behavior 2013-04-08 07:15:38 +02:00
Tatsuhiro Tsujikawa
35d00f6b7f Remove meta directive for now since it breaks manpage generation 2013-04-06 16:05:27 +09:00
Tatsuhiro Tsujikawa
81718d698b Update pt manual translation
Contributed by Gilberto dos Santos Alves
2013-04-05 00:51:15 +09:00
ITriskTI
ad75b0e0c1 Update aria2c.rst 2013-04-04 01:15:27 +03:00
Tatsuhiro Tsujikawa
7d65d38807 Remove --enable-async-dns6 from manual 2013-04-02 00:07:43 +09:00
ITriskTI
d77f16f5ba Update aria2c.rst 2013-03-06 11:12:56 +03:00
Nils Maier
4f2c1b86eb Allow for out-of-tree Sphinx builds 2013-03-03 14:50:16 +01:00
Tatsuhiro Tsujikawa
66a85777ad Document UDP tracker in manual 2013-03-03 18:28:25 +09:00
Nils Maier
1596e83a83 Document -i/--save-session gzip behaviour 2013-03-02 15:48:26 +01:00
Tatsuhiro Tsujikawa
38fc5de154 doc: Specify static file explicitly 2013-02-19 23:34:28 +09:00
Tatsuhiro Tsujikawa
e8491b989b Add Portuguese manual
This translation is based on aria2 version 1.15.2 manual.
Contributed by Gilberto dos Santos Alves
2013-02-19 23:22:22 +09:00
Tatsuhiro Tsujikawa
4095b2ec6b Update doc 2013-02-19 22:14:18 +09:00
Tatsuhiro Tsujikawa
7c2404db5e Set language=ru in ru/conf.py.in 2013-02-18 00:33:02 +09:00
Tatsuhiro Tsujikawa
68919a2412 Update doc css 2013-02-18 00:31:51 +09:00
Tatsuhiro Tsujikawa
b9ee9a1195 doc: Customize theme 2013-02-02 20:57:35 +09:00
Tatsuhiro Tsujikawa
1639ca5b5b Update bash_completion 2013-01-29 22:22:15 +09:00
ITriskTI
f8cb9b67de Update and fixed some bugs 2013-01-27 21:12:55 +03:00
Tatsuhiro Tsujikawa
382cb9a191 Document about k and m can be used as well as K and M. 2013-01-27 21:13:24 +09:00
Tatsuhiro Tsujikawa
74e570de37 Documented --save-session-interval option in man page 2013-01-10 00:18:14 +09:00
Tatsuhiro Tsujikawa
794f7b7014 Documented --referer="*" in man page 2013-01-08 21:46:50 +09:00
Tatsuhiro Tsujikawa
58c047a4a8 Documented --console-log-level option in man page 2013-01-08 21:27:26 +09:00
Tatsuhiro Tsujikawa
e9de4db0d5 Updated bash_completion 2012-12-26 23:28:42 +09:00
ITriskTI
d2892cf7b4 Update doc/manual-src/ru/aria2c.rst 2012-12-17 11:13:53 +03:00
Tatsuhiro Tsujikawa
77a4ee4de0 Save gid option with --save-session option 2012-12-17 00:33:11 +09:00
Tatsuhiro Tsujikawa
983cb3683a Documented --gid option and updated RPC interface section in man page 2012-12-16 21:31:28 +09:00
Tatsuhiro Tsujikawa
0001f4cfbd Added --gid option
This option sets GID manually. aria2 identifies each download by the
ID called GID. The GID must be hex string of 16 characters, thus
[0-9a-zA-Z] are allowed and leading zeros must not be stripped. The
GID all 0 is reserved and must not be used. The GID must be unique,
otherwise error is reported and the download is not added.  This
option is useful when restoring the sessions saved using
--save-session option. If this option is not used, new GID is
generated by aria2.
2012-12-16 18:22:13 +09:00
ITriskTI
8c3e08f15a Update doc/manual-src/ru/aria2c.rst 2012-12-12 21:28:17 +03:00
Tatsuhiro Tsujikawa
2235743de3 Changed console readout, making it more compact
"SIZE:" is removed because it is obvious. SEEDING, SEED, SPD and UP
are now replaced with SEED, SD, DL and UL respectively.
2012-12-12 23:22:04 +09:00
Tatsuhiro Tsujikawa
0c491b86d0 Documented --disk-cache option in man page 2012-12-07 01:01:33 +09:00
ITriskTI
f52d7024d1 Update doc/manual-src/ru/aria2c.rst 2012-11-17 13:20:02 +03:00
Tatsuhiro Tsujikawa
5f04183672 Updated bash_completion 2012-11-17 15:44:08 +09:00
Tatsuhiro Tsujikawa
c8e7100248 Documented --force-save option in man page 2012-11-17 15:41:37 +09:00
Tatsuhiro Tsujikawa
7db480b024 Updated bash_completion 2012-10-31 22:48:45 +09:00
ITriskTI
cb5984ce52 Update doc/manual-src/ru/aria2c.rst 2012-10-31 12:47:11 +03:00
Tatsuhiro Tsujikawa
d4e7b51eb9 Made --http-no-cache false by default 2012-10-31 16:44:28 +09:00
Tatsuhiro Tsujikawa
4d6c1a8748 Added .gitignore in doc/manual-src 2012-10-31 16:36:45 +09:00
ITriskTI
bc33433e58 Update and fixed some bugs 2012-10-17 10:40:11 +03:00
Tatsuhiro Tsujikawa
b48d9082db Documented --rpc-save-upload-metadata option in manpage 2012-10-16 22:55:35 +09:00
Tatsuhiro Tsujikawa
bc3c553b3c Updated doc 2012-09-30 19:08:40 +09:00
Tatsuhiro Tsujikawa
492d6d1eeb Added RPC encryption command-line example 2012-09-30 17:07:54 +09:00
Tatsuhiro Tsujikawa
71cc44bedd Documented --rpc-private-key, --rpc-certificate and --rpc-secure in manpage 2012-09-30 17:04:14 +09:00
Tatsuhiro Tsujikawa
e83b03b2cd aria2rpc: Added appendUri command
This command calls aria2.changeUri(GID, fileIndex, [], [URI,...])
internally.
2012-09-23 22:38:52 +09:00
Tatsuhiro Tsujikawa
2c4da71325 Updated bash_completion 2012-09-02 21:20:03 +09:00
ITriskTI
d59300d582 Update doc/manual-src/ru/aria2c.rst
Fixed lines starts with words starting "." (bug Sphinx)
2012-08-25 16:41:57 +03:00
ITriskTI
129489d1b2 Update doc/manual-src/ru/aria2c.rst 2012-08-25 14:49:41 +03:00
Tatsuhiro Tsujikawa
d734ff7d29 Added new file allocation method called 'trunc'
--file-allocation option can now take new value 'trunc'. 'trunc' uses
ftruncate() system call or platform-specific counterpart to truncate a
file to a specified length.
2012-08-12 16:52:53 +09:00
Tatsuhiro Tsujikawa
27e44439ea Fixed markup 2012-08-11 21:17:03 +09:00
Tatsuhiro Tsujikawa
ab6a22119e Added technical notes
It contains control file format and dht.dat file format.
2012-08-01 00:04:48 +09:00
Tatsuhiro Tsujikawa
7cd2a94e73 Updated bash_completion file 2012-07-30 21:37:46 +09:00
ITriskTI
c7131c14fe Update and fixed some bugs 2012-07-07 14:40:52 +03:00
Tatsuhiro Tsujikawa
9ce6a831c3 Exchanged README and aria2c page in toctree. 2012-07-07 00:46:03 +09:00
Tatsuhiro Tsujikawa
ea04bd6024 Updated copyright year in manpage 2012-07-07 00:14:29 +09:00
Tatsuhiro Tsujikawa
535d22e24c Migrated ConsoleReadout wiki page to manpage.
Also updated other part of manpage.
2012-07-07 00:06:12 +09:00
Tatsuhiro Tsujikawa
fc058066e5 Included README.rst from manual-src/en/index.rst 2012-07-06 23:40:29 +09:00
Tatsuhiro Tsujikawa
519076e779 Updated doc about system-wide ca 2012-07-06 21:30:00 +09:00
ITriskTI
238c3128de Update master 2012-06-30 23:22:36 +03:00
Tatsuhiro Tsujikawa
d765dbb2f5 Quoted .metalink, .meta4 and .torrent with '"' in man page
This is because when generating man page, if a word starting '.' is
put in the beginning of the line, it will be treated as macro.  This
sounds like docutils bug, but it will not be fixed soon, so we do this
as a workaround.
2012-06-30 21:56:44 +09:00
Tatsuhiro Tsujikawa
3ce6070107 Added enable-mmap to -i list option. Sorted -i list option list. 2012-06-27 01:10:06 +09:00
ITriskTI
539a87d584 Update master 2012-06-24 17:05:43 +03:00
Tatsuhiro Tsujikawa
8bbf279ba3 Documented --enable-mmap in man page 2012-06-24 17:02:48 +09:00
Tatsuhiro Tsujikawa
f3a5aa3bef Renamed clean as doclean in Makefile for manuals.
This will prevent `make clean` in unpacked archive from removing
aria2c.1. We don't want to remove them by `make clean` because to
generate aria2c.1, user has to install Sphinx. That is why we
distribute aria2c.1 in the archive.
2012-05-27 18:51:27 +09:00
Tatsuhiro Tsujikawa
0ba12fdc32 Removed outdated README.txt 2012-05-19 23:07:19 +09:00
Tatsuhiro Tsujikawa
8ebba32fd9 Change manual build dir to doc/manual-src/*/_build. Drop html install.
Sphinx HTML markups are beautiful, but it uses many asset files, such
as stylesheets, javascripts and images.  While it is no problem to
upload them in web site, but distributing and installing them in
individual user have some problems.  For example, Sphinx uses same
assets for generated sites, so if many applications uses Sphinx
generated docs and they are installed in the PC, it is huge waste of
the disk space. I'm also not comfortable to copy HTML trees to the
install directory using 'cp -r' command.  I seeked other format like
pdf and texi which Sphinx can generate but annoyingly they all convert
'--' into en-dash and there is no workaround to disable it. So I
decided to drop HTML manual from distribution and installation.  For
users who want to HTML version manual, see it online:
http://aria2.sourceforge.net/manual/en/html/
2012-05-19 18:08:01 +09:00
ITriskTI
8019ad602a Fixed typo 2012-05-15 18:24:59 +03:00
Tatsuhiro Tsujikawa
06405ce97b Removed aria2c.rst from the prerequisites of $(HTML)
$(HTML) is the root directory of html documents and since we don't
remove $(HTML) when re-building htmls, it is useless to use aria2c.rst
as a prerequisites.
2012-05-13 16:59:55 +09:00
Tatsuhiro Tsujikawa
19798f09ae Fixed typo 2012-05-12 19:33:33 +09:00
Tatsuhiro Tsujikawa
57519611ff Added --with-bashcompletiondir configure option.
By default, bash_completion file named aria2c is installed to the
directory $prefix/share/doc/aria2/bash_completion.  To change the
install directory of the file, use --with-bashcompletiondir option.
2012-05-12 19:19:57 +09:00
Tatsuhiro Tsujikawa
b4f3f41464 Fixed make distcheck error 2012-05-12 19:19:38 +09:00
Tatsuhiro Tsujikawa
a1d5d5ef9d Added aria2c.rst to EXTRA_DIST 2012-05-10 01:06:26 +09:00
Tatsuhiro Tsujikawa
5323fa1029 Honor DESTDIR when installing HTML version manual.
Generate HTML version manual on `make install`.
2012-05-08 01:10:46 +09:00
Tatsuhiro Tsujikawa
c046573ab8 Fixed typo and nits 2012-04-23 21:14:19 +09:00
ITriskTI
4d17715b66 Update doc/manual-src/ru/index.rst 2012-04-23 03:26:38 +03:00
ITriskTI
3c5753baf2 fixed some bugs 2012-04-23 03:24:30 +03:00
Tatsuhiro Tsujikawa
eec761ec43 Removed old manual page sources. 2012-04-22 21:26:25 +09:00
Tatsuhiro Tsujikawa
4a5f2b6f9f Use Sphinx for aria2 manual page documentation.
The source files for manual pages are placed under doc/manual-src.
The built manual pages are placed under doc/manual.
When installed, manual pages are placed under $(docdir)/manual/.
2012-04-22 21:21:26 +09:00
Tatsuhiro Tsujikawa
3dc5437ee2 Updated bash_completion 2012-04-02 20:58:17 +09:00
ITriskTI
4ab8e63d82 Updated Russian man page 2012-03-26 14:26:50 +03:00
Tatsuhiro Tsujikawa
8499a47d21 Added --bt-remove-unselected-file option.
Removes the unselected files when download is completed in
BitTorrent. To selecting files, use --select-file option. If it is not
used, all files are assumed to be selected. Please use this option
with care because it will actually remove files from your disk.
This option is default to false.
2012-03-25 19:25:43 +09:00
Tatsuhiro Tsujikawa
9669bafb7f Updated man page 2012-03-25 00:51:46 +09:00