Changeset 25828 in project


Ignore:
Timestamp:
01/26/12 01:47:11 (9 years ago)
Author:
svnwiki
Message:

Anonymous wiki edit for IP [69.117.234.22]: Added "List of Procedures" and "Internal Binding Documentation" sections.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/proccpuinfo

    r25827 r25828  
    77[[toc:]]
    88
    9 === Usage
     9=== Usage Example
    1010
    1111  (use proccpuinfo)
     12
     13  (proccpuinfo 'architecture)
     14  (proccpuinfo 'hardware-platform)
     15  (proccpuinfo 'frequency)
     16  (proccpuinfo 'bogomips)
     17  (proccpuinfo 'cache)
     18  (proccpuinfo 'cpus)
     19  (proccpuinfo 'cputype)
    1220
    1321=== Requirements
     
    1725=== Synopsis
    1826
    19 
    2027This egg contains thoroughly commented Chicken code (mainly in the
    2128{{"proccpuinfo.scm"}} file) which is intended to be an example of how
     
    2330
    2431=== Installation
    25 
    2632
    2733This binding is distributed as a Chicken egg.  To compile and
     
    5763in place of {{"/usr/local/libproccpuinfo"}}
    5864
     65=== List of Procedures
     66
     67This egg only exports a single procedure:
     68
     69<procedure>(proccpuinfo DESIRED-INFO [filename: FILENAME] [arch: ARCHITECTURE])</procedure>
     70
     71Where {{DESIRED-INFO}} is one of the following:
     72
     73* 'architecture
     74* 'hardware-platform
     75* 'frequency
     76* 'bogomips
     77* 'cache
     78* 'cpus
     79* 'cputype
     80
     81and {{FILENAME}} is an optional string containing the name of the file
     82to read from instead of the default {{"/proc/cpuinfo"}}
     83
     84and {{ARCHITECTURE}} is an optional string that will be used to interpret
     85the cpuinfo file as if it was read on a different architecture.
     86
     87This procedure will return the desired entry from {{"/proc/cpuinfo"}} or
     88the given {{FILENAME}}, or {{#f}} if there is no such entry.
     89
     90Please see the [[http://www.nongnu.org/proccpuinfo/libproccpuinfo-guide.html|libproccpuinfo documentation]]
     91for more information.
     92
     93=== Internal Binding Documentation
     94
     95Please see the comments in the source (the "proccpuinfo.scm" file in particular)
     96for a detailed explanation of how the binding works.  A tutorial article regarding
     97this binding is forthcoming.  Watch [[http://wiki.call-cc.org/tutorials|this space]].
     98
    5999=== License
    60100
Note: See TracChangeset for help on using the changeset viewer.