Changeset 37453 in project


Ignore:
Timestamp:
03/24/19 18:03:35 (6 months ago)
Author:
Jim Ursetto
Message:

wiki/chicken-doc: -R chicken.platform for chicken-home on C5

Fixes #2 (https://github.com/ursetto/chicken-doc/issues/2)

Location:
wiki/eggref
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/chicken-doc

    r37084 r37453  
    2626==== Pre-built packages
    2727
    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
     28Chicken 4 documentation tarballs, built from the {{man/4}} and {{eggref/4}} directories
     29in 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
    3334the latest wiki documentation.
    3435
    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:
     36Chicken 5 documentation tarballs, built from the {{man/5}} and {{eggref/5}} directories
     37in 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
     42distinguish them from the Chicken 4 versions. They are updated daily from
     43the latest wiki documentation.
     44
     45Download your preferred format---either documentation version can be served
     46from 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
     49For example, on Chicken 4, serving Chicken 4 docs:
    3850
    3951 $ 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
     54And 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
     59The tarball will be extracted into the directory {{./chicken-doc/}}.
    4360If you installed into a non-default location, {{CHICKEN_DOC_REPOSITORY}}
    4461must include this entire path.
  • wiki/eggref/4/chicken-doc-admin

    r37084 r37453  
    3535 $ chicken-doc-admin -i
    3636
    37 Now download and process the wiki documentation:
     37Check out the wiki documentation:
    3838
    3939 $ 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
     42To import Chicken 5 documentation:
     43
     44 $ chicken-doc-admin -m wiki/man/5
     45 $ chicken-doc-admin -e wiki/eggref/5
     46
     47To import Chicken 4 documentation, use 4 instead of 5:
     48
    4149 $ chicken-doc-admin -m wiki/man/4
    4250 $ chicken-doc-admin -e wiki/eggref/4
     51
     52{{chicken-doc-admin}} is aware of the structure of both Chicken 4 and Chicken 5
     53manual pages and will automatically import them appropriately. Both Chicken 4
     54and 5 can serve either documentation version.
     55
    4356
    4457==== Locally installed egg documentation
  • wiki/eggref/5/chicken-doc

    r37083 r37453  
    2626==== Pre-built packages
    2727
    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
     28Chicken 4 documentation tarballs, built from the {{man/4}} and {{eggref/4}} directories
     29in 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
    3334the latest wiki documentation.
    3435
    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:
     36Chicken 5 documentation tarballs, built from the {{man/5}} and {{eggref/5}} directories
     37in 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
     42distinguish them from the Chicken 4 versions. They are updated daily from
     43the latest wiki documentation.
     44
     45Download your preferred format---either documentation version can be served
     46from 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
     49For example, on Chicken 4, serving Chicken 4 docs:
    3850
    3951 $ 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
     54And 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
     59The tarball will be extracted into the directory {{./chicken-doc/}}.
    4360If you installed into a non-default location, {{CHICKEN_DOC_REPOSITORY}}
    4461must include this entire path.
  • wiki/eggref/5/chicken-doc-admin

    r37083 r37453  
    3535 $ chicken-doc-admin -i
    3636
    37 Now download and process the wiki documentation:
     37Check out the wiki documentation:
    3838
    3939 $ 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
     42To import Chicken 5 documentation:
     43
     44 $ chicken-doc-admin -m wiki/man/5
     45 $ chicken-doc-admin -e wiki/eggref/5
     46
     47To import Chicken 4 documentation, use 4 instead of 5:
     48
    4149 $ chicken-doc-admin -m wiki/man/4
    4250 $ chicken-doc-admin -e wiki/eggref/4
     51
     52{{chicken-doc-admin}} is aware of the structure of both Chicken 4 and Chicken 5
     53manual pages and will automatically import them appropriately. Both Chicken 4
     54and 5 can serve either documentation version.
     55
    4356
    4457==== Locally installed egg documentation
Note: See TracChangeset for help on using the changeset viewer.