Nils Maier
9768aa9fad
WinTLS: Document PKCS12-only support.
2013-09-30 13:53:21 +02:00
ITriskTI
f2137eb784
Fixed a typo in the English manual
...
Closes #133
2013-09-25 02:51:31 +02:00
Nils Maier
2f1f45bcc5
Document PKCS12 availability
2013-09-22 12:55:27 +02:00
Nils Maier
7ca627bfe9
Fix out-of-tree builds of libaria2api
...
Also it's not just the `html` target that needs libaria2api generated.
The fix is mighty ackward, as it is not really out-of-tree: libaria2api
still will be but into the srcdir. I settled for this because trying to
do a real include from the build dir is really a mess, either requireing
heavy pre-processing or a custom sphinx Include directive :p
2013-09-09 23:35:15 +02:00
Nils Maier
72c5aaa31a
Give hint on how to install sphinx-build
...
... and remove trailing parenthesis from warning messages
2013-08-24 20:09:39 +02:00
Tatsuhiro Tsujikawa
d87365efc6
Use @echo instead of $(warning ...) to suppress warning on autoreconf
2013-08-21 00:40:30 +09:00
Nils Maier
02c65e0eca
Always build doc/manual-src
...
Should sphinx-build be not available AND the man file not be prsent,
then just "touch" it into existence (and warn about that)
2013-08-19 00:16:54 +02:00
Nils Maier
4be7ec380f
Change defaults: Enable 16M disk cache by default.
2013-08-12 20:51:19 +02:00
Tatsuhiro Tsujikawa
de55569de5
Always save control file if --force-save is given
2013-07-28 18:07:29 +09:00
Tatsuhiro Tsujikawa
4ff6a9f1d4
Do the same doc improvements to --follow-metalink
2013-06-12 21:37:30 +09:00
gt
75d3e6f4dd
Improvements to --follow-torrent=false documentation.
2013-06-11 23:49:09 +05:30
Tatsuhiro Tsujikawa
e8b27b7017
libaria2.rst: Fix typo
2013-05-28 23:45:29 +09:00
Tatsuhiro Tsujikawa
91e0fdbc24
Remove clean-local not to remove generated man pages with `make clean`
...
Because we don't require sphinx-doc to build distributed archive, the
man pages are generated when making distribution. And We want to keep
the generated man pages with `make clean` there.
2013-05-26 01:14:00 +09:00
Tatsuhiro Tsujikawa
42d3408b50
Add libaria2 tutorial
2013-05-21 23:53:21 +09:00
Tatsuhiro Tsujikawa
aca6b0b68c
Update doc style
2013-05-18 19:01:49 +09:00
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
Nils Maier
f9225db135
AppleTLS: Document new --rpc-certificate behavior
2013-04-08 07:15:38 +02:00
Tatsuhiro Tsujikawa
7d65d38807
Remove --enable-async-dns6 from manual
2013-04-02 00:07:43 +09: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
4095b2ec6b
Update doc
2013-02-19 22:14:18 +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
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
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
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
Tatsuhiro Tsujikawa
c8e7100248
Documented --force-save option in man page
2012-11-17 15:41:37 +09:00
Tatsuhiro Tsujikawa
d4e7b51eb9
Made --http-no-cache false by default
2012-10-31 16:44:28 +09: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
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
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
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
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
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
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
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
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