Changeset 37453 in project
- Timestamp:
- 03/24/19 18:03:35 (22 months ago)
- Location:
- wiki/eggref
- Files:
-
- 4 edited
Legend:
- Unmodified
- Added
- Removed
-
wiki/eggref/4/chicken-doc
r37084 r37453 26 26 ==== Pre-built packages 27 27 28 Documentation tarballs are provided in 29 [[http://3e8.org/pub/chicken-doc/chicken-doc-repo.tgz|gzip]], 30 [[http://3e8.org/pub/chicken-doc/chicken-doc-repo.tar.bz2|bzip2]] and 31 [[http://3e8.org/pub/chicken-doc/chicken-doc-repo.zip|zip]] format at 32 [[http://3e8.org/pub/chicken-doc/]]. They are updated daily from 28 Chicken 4 documentation tarballs, built from the {{man/4}} and {{eggref/4}} directories 29 in SVN, are provided in 30 [[https://3e8.org/pub/chicken-doc/chicken-doc-repo.tgz|gzip]], 31 [[https://3e8.org/pub/chicken-doc/chicken-doc-repo.tar.bz2|bzip2]] and 32 [[https://3e8.org/pub/chicken-doc/chicken-doc-repo.zip|zip]] format at 33 [[https://3e8.org/pub/chicken-doc/]]. They are updated daily from 33 34 the latest wiki documentation. 34 35 35 Download your preferred format and extract it into the default 36 location {{(chicken-home)}} or into some other writable directory of your 37 choice. For example, on UNIX: 36 Chicken 5 documentation tarballs, built from the {{man/5}} and {{eggref/5}} directories 37 in SVN, are provided in 38 [[https://3e8.org/pub/chicken-doc/chicken-doc-repo-5.tgz|gzip]], 39 [[https://3e8.org/pub/chicken-doc/chicken-doc-repo-5.tar.bz2|bzip2]] and 40 [[https://3e8.org/pub/chicken-doc/chicken-doc-repo-5.zip|zip]] format at 41 [[https://3e8.org/pub/chicken-doc/]]. They have a {{-5}} in their names to 42 distinguish them from the Chicken 4 versions. They are updated daily from 43 the latest wiki documentation. 44 45 Download your preferred format---either documentation version can be served 46 from Chicken 4 or Chicken 5---and extract it into the default location 47 {{(chicken-home)}} or into some other writable directory of your choice. 48 49 For example, on Chicken 4, serving Chicken 4 docs: 38 50 39 51 $ cd `csi -p '(chicken-home)'` 40 $ curl http://3e8.org/pub/chicken-doc/chicken-doc-repo.tgz | sudo tar zx 41 42 The tarball will be extracted into the directory {{chicken-doc/}}. 52 $ curl https://3e8.org/pub/chicken-doc/chicken-doc-repo.tgz | sudo tar zx 53 54 And on Chicken 5, serving Chicken 5 docs: 55 56 $ cd `csi -R chicken.platform -p '(chicken-home)'` 57 $ curl https://3e8.org/pub/chicken-doc/chicken-doc-repo-5.tgz | sudo tar zx 58 59 The tarball will be extracted into the directory {{./chicken-doc/}}. 43 60 If you installed into a non-default location, {{CHICKEN_DOC_REPOSITORY}} 44 61 must include this entire path. -
wiki/eggref/4/chicken-doc-admin
r37084 r37453 35 35 $ chicken-doc-admin -i 36 36 37 Now download and processthe wiki documentation:37 Check out the wiki documentation: 38 38 39 39 $ svn co --username anonymous --password "" \ 40 http://code.call-cc.org/svn/chicken-eggs/wiki 40 https://code.call-cc.org/svn/chicken-eggs/wiki 41 42 To import Chicken 5 documentation: 43 44 $ chicken-doc-admin -m wiki/man/5 45 $ chicken-doc-admin -e wiki/eggref/5 46 47 To import Chicken 4 documentation, use 4 instead of 5: 48 41 49 $ chicken-doc-admin -m wiki/man/4 42 50 $ chicken-doc-admin -e wiki/eggref/4 51 52 {{chicken-doc-admin}} is aware of the structure of both Chicken 4 and Chicken 5 53 manual pages and will automatically import them appropriately. Both Chicken 4 54 and 5 can serve either documentation version. 55 43 56 44 57 ==== Locally installed egg documentation -
wiki/eggref/5/chicken-doc
r37083 r37453 26 26 ==== Pre-built packages 27 27 28 Documentation tarballs are provided in 29 [[http://3e8.org/pub/chicken-doc/chicken-doc-repo.tgz|gzip]], 30 [[http://3e8.org/pub/chicken-doc/chicken-doc-repo.tar.bz2|bzip2]] and 31 [[http://3e8.org/pub/chicken-doc/chicken-doc-repo.zip|zip]] format at 32 [[http://3e8.org/pub/chicken-doc/]]. They are updated daily from 28 Chicken 4 documentation tarballs, built from the {{man/4}} and {{eggref/4}} directories 29 in SVN, are provided in 30 [[https://3e8.org/pub/chicken-doc/chicken-doc-repo.tgz|gzip]], 31 [[https://3e8.org/pub/chicken-doc/chicken-doc-repo.tar.bz2|bzip2]] and 32 [[https://3e8.org/pub/chicken-doc/chicken-doc-repo.zip|zip]] format at 33 [[https://3e8.org/pub/chicken-doc/]]. They are updated daily from 33 34 the latest wiki documentation. 34 35 35 Download your preferred format and extract it into the default 36 location {{(chicken-home)}} or into some other writable directory of your 37 choice. For example, on UNIX: 36 Chicken 5 documentation tarballs, built from the {{man/5}} and {{eggref/5}} directories 37 in SVN, are provided in 38 [[https://3e8.org/pub/chicken-doc/chicken-doc-repo-5.tgz|gzip]], 39 [[https://3e8.org/pub/chicken-doc/chicken-doc-repo-5.tar.bz2|bzip2]] and 40 [[https://3e8.org/pub/chicken-doc/chicken-doc-repo-5.zip|zip]] format at 41 [[https://3e8.org/pub/chicken-doc/]]. They have a {{-5}} in their names to 42 distinguish them from the Chicken 4 versions. They are updated daily from 43 the latest wiki documentation. 44 45 Download your preferred format---either documentation version can be served 46 from Chicken 4 or Chicken 5---and extract it into the default location 47 {{(chicken-home)}} or into some other writable directory of your choice. 48 49 For example, on Chicken 4, serving Chicken 4 docs: 38 50 39 51 $ cd `csi -p '(chicken-home)'` 40 $ curl http://3e8.org/pub/chicken-doc/chicken-doc-repo.tgz | sudo tar zx 41 42 The tarball will be extracted into the directory {{chicken-doc/}}. 52 $ curl https://3e8.org/pub/chicken-doc/chicken-doc-repo.tgz | sudo tar zx 53 54 And on Chicken 5, serving Chicken 5 docs: 55 56 $ cd `csi -R chicken.platform -p '(chicken-home)'` 57 $ curl https://3e8.org/pub/chicken-doc/chicken-doc-repo-5.tgz | sudo tar zx 58 59 The tarball will be extracted into the directory {{./chicken-doc/}}. 43 60 If you installed into a non-default location, {{CHICKEN_DOC_REPOSITORY}} 44 61 must include this entire path. -
wiki/eggref/5/chicken-doc-admin
r37083 r37453 35 35 $ chicken-doc-admin -i 36 36 37 Now download and processthe wiki documentation:37 Check out the wiki documentation: 38 38 39 39 $ svn co --username anonymous --password "" \ 40 http://code.call-cc.org/svn/chicken-eggs/wiki 40 https://code.call-cc.org/svn/chicken-eggs/wiki 41 42 To import Chicken 5 documentation: 43 44 $ chicken-doc-admin -m wiki/man/5 45 $ chicken-doc-admin -e wiki/eggref/5 46 47 To import Chicken 4 documentation, use 4 instead of 5: 48 41 49 $ chicken-doc-admin -m wiki/man/4 42 50 $ chicken-doc-admin -e wiki/eggref/4 51 52 {{chicken-doc-admin}} is aware of the structure of both Chicken 4 and Chicken 5 53 manual pages and will automatically import them appropriately. Both Chicken 4 54 and 5 can serve either documentation version. 55 43 56 44 57 ==== Locally installed egg documentation
Note: See TracChangeset
for help on using the changeset viewer.