mirror/libcpuid
1
0
Fork 0
mirror of https://github.com/anrieff/libcpuid synced 2025-02-12 20:24:05 +00:00
Code Issues Releases Wiki Activity

Fix issue #66: Manpage for cpuid_tool

Browse source 
The man-page is generated with Doxygen, similar to the lib docs.
This commit is contained in:
Veselin Georgiev 2016-09-20 15:35:24 +03:00
parent a68792dc2c
commit a7a31743a2
3 changed files with 13 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
cpuid_tool/cpuid_tool.c
View file

@ -25,27 +25,28 @@
*/ */
/** /**
* @File cpuid_tool.c * @page cpuid_tool
* @Date 2008-11-19 * @date 2008-11-19
* @Author Veselin Georgiev * @author Veselin Georgiev
* @Brief Command line interface to libcpuid * @brief Command line interface to libcpuid
* *
* @details
* This file is provides a direct interface to libcpuid. See the usage() * This file is provides a direct interface to libcpuid. See the usage()
* function (or just run the program with the `--help' switch) for a short * function (or just run the program with the `--help' switch) for a short
* command line options reference. * command line options reference.
* *
* This file has several purposes: * This file has several purposes:
* *
* 1) When started with no arguments, the program outputs the RAW and decoded * 1. When started with no arguments, the program outputs the RAW and decoded
* CPU data to files (`raw.txt' and `report.txt', respectively) - this is * CPU data to files (`raw.txt' and `report.txt', respectively) - this is
* intended to be a dumb, doubleclicky tool for non-developer * intended to be a dumb, doubleclicky tool for non-developer
* users, that can provide debug info about unrecognized processors to * users, that can provide debug info about unrecognized processors to
* libcpuid developers. * libcpuid developers.
* 2) When operated from the terminal with the `--report' option, it is a * 2. When operated from the terminal with the `--report' option, it is a
* generic CPU-info utility. * generic CPU-info utility.
* 3) Can be used in shell scripts, e.g. to get the name of the CPU, cache * 3. Can be used in shell scripts, e.g. to get the name of the CPU, cache
* sizes, features, with query options like `--cache', `--brandstr', etc. * sizes, features, with query options like `--cache', `--brandstr', etc.
* 4) Finally, it serves to self-document libcpiud itself :) * 4. Finally, it serves to self-document libcpiud itself :)
*/ */
#include <stdio.h> #include <stdio.h>
#include <string.h> #include <string.h>

2
libcpuid/Doxyfile.in
View file

@ -436,7 +436,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # with spaces.
INPUT = @top_srcdir@/libcpuid INPUT = @top_srcdir@/libcpuid @top_srcdir@/cpuid_tool/cpuid_tool.c
# If the value of the INPUT tag contains directories, you can use the # If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp

4
libcpuid/Makefile.am
View file

@ -44,12 +44,14 @@ dist_man_MANS = $(directory)/cpu_id_t.3 \
$(directory)/cpu_list_t.3 \ $(directory)/cpu_list_t.3 \
$(directory)/cpu_mark_t.3 \ $(directory)/cpu_mark_t.3 \
$(directory)/cpu_raw_data_t.3 \ $(directory)/cpu_raw_data_t.3 \
$(directory)/libcpuid.3 $(directory)/libcpuid.3 \
$(directory)/cpuid_tool.3
$(directory)/cpu_id_t.3: doxyfile.stamp $(directory)/cpu_id_t.3: doxyfile.stamp
$(directory)/cpu_list_t.3: doxyfile.stamp $(directory)/cpu_list_t.3: doxyfile.stamp
$(directory)/cpu_mark_t.3: doxyfile.stamp $(directory)/cpu_mark_t.3: doxyfile.stamp
$(directory)/cpu_raw_data_t.3: doxyfile.stamp $(directory)/cpu_raw_data_t.3: doxyfile.stamp
$(directory)/libcpuid.3: doxyfile.stamp $(directory)/libcpuid.3: doxyfile.stamp
$(directory)/cpuid_tool.3: doxyfile.stamp
doxyfile.stamp: doxyfile.stamp:
$(DOXYGEN) Doxyfile $(DOXYGEN) Doxyfile