Show
Ignore:
Timestamp:
02/15/09 21:42:43 (4 years ago)
Author:
khali
Message:

Reformat synopsis section.

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • lm-sensors/trunk/lib/libsensors.3

    r5647 r5650  
    2727.\"     libsensors source code 
    2828.TH libsensors 3  "February 2009" "lm-sensors 3" "Linux Programmer's Manual" 
     29 
    2930.SH NAME 
    3031libsensors \- publicly accessible functions provided by the sensors library 
     32 
    3133.SH SYNOPSIS 
    3234.nf 
    3335.B #include <sensors/sensors.h> 
    3436 
    35 .B int sensors_init(FILE *input); 
     37/* Library initialization and clean-up */ 
     38.BI "int sensors_init(FILE *" input ");" 
    3639.B void sensors_cleanup(void); 
    37 .B int sensors_parse_chip_name(const char *orig_name, 
    38                             \fBsensors_chip_name *res);\fP 
    39 .B const char *sensors_get_adapter_name(int bus_nr); 
    40 .B char *sensors_get_label(const sensors_chip_name *name, const sensors_feature *feature);\fP 
    41 .B int sensors_get_value(const sensors_chip_name *name, int subfeat_nr, 
    42                       \fBdouble *value);\fP 
    43 .B int sensors_set_value(const sensors_chip_name *name, int subfeat_nr, 
    44                       \fBdouble value);\fP 
    45 .B int sensors_do_chip_sets(const sensors_chip_name *name); 
    46 .B const sensors_chip_name *sensors_get_detected_chips(const sensors_chip_name 
    47                                                     \fB*match, int *nr);\fP 
    48 .B const sensors_feature *sensors_get_features(const sensors_chip_name *name, int *nr);\fP 
    49 .B const sensors_subfeature *sensors_get_all_subfeatures(const sensors_chip_name *name, const sensors_feature *feature, int *nr);\fP 
    50 .B const sensors_subfeature *sensors_get_subfeature(const sensors_chip_name *name, const sensors_feature *feature, sensors_subfeature_type type);\fP 
    51 .B const char *libsensors_version; 
     40.BI "const char *" libsensors_version ";" 
     41 
     42/* Chip name handling */ 
     43.BI "int sensors_parse_chip_name(const char *" orig_name "," 
     44.BI "                            sensors_chip_name *" res ");" 
     45.BI "const char *sensors_get_adapter_name(const sensors_bus_id *" bus ");" 
     46 
     47/* Chips and features enumeration */ 
     48.B const sensors_chip_name * 
     49.BI "sensors_get_detected_chips(const sensors_chip_name *" match "," 
     50.BI "                           int *" nr ");" 
     51.B const sensors_feature * 
     52.BI "sensors_get_features(const sensors_chip_name *" name "," 
     53.BI "                     int *" nr ");" 
     54.B const sensors_subfeature * 
     55.BI "sensors_get_all_subfeatures(const sensors_chip_name *" name "," 
     56.BI "                            const sensors_feature *" feature "," 
     57.BI "                            int *" nr ");" 
     58.B const sensors_subfeature * 
     59.BI "sensors_get_subfeature(const sensors_chip_name *" name "," 
     60.BI "                       const sensors_feature *" feature "," 
     61.BI "                       sensors_subfeature_type " type ");" 
     62 
     63/* Features access */ 
     64.BI "char *sensors_get_label(const sensors_chip_name *" name "," 
     65.BI "                        const sensors_feature *" feature ");" 
     66.BI "int sensors_get_value(const sensors_chip_name *" name ", int " subfeat_nr "," 
     67.BI "                      double *" value ");" 
     68.BI "int sensors_set_value(const sensors_chip_name *" name ", int " subfeat_nr "," 
     69.BI "                      double " value ");" 
     70.BI "int sensors_do_chip_sets(const sensors_chip_name *" name ");" 
    5271.fi 
     72 
    5373.SH DESCRIPTION 
    5474.B int sensors_init(FILE *input);