kernelnewbies.kernelnewbies.org archive mirror
 help / color / mirror / Atom feed
* Man pages for Kernel API
@ 2014-06-03  4:42 Dipanjan Das
  2014-06-03 18:19 ` John de la Garza
  0 siblings, 1 reply; 6+ messages in thread
From: Dipanjan Das @ 2014-06-03  4:42 UTC (permalink / raw)
  To: kernelnewbies

Hi,

Like there is section #2 of man pages dedicated to syscalls, is there any
official way to get the list of all supported Kernal APIs?
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.kernelnewbies.org/pipermail/kernelnewbies/attachments/20140603/6f06098c/attachment-0001.html 

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Man pages for Kernel API
  2014-06-03  4:42 Man pages for Kernel API Dipanjan Das
@ 2014-06-03 18:19 ` John de la Garza
  2014-06-04  8:51   ` navid Rahimi
  0 siblings, 1 reply; 6+ messages in thread
From: John de la Garza @ 2014-06-03 18:19 UTC (permalink / raw)
  To: kernelnewbies

On Tue, Jun 03, 2014 at 10:12:24AM +0530, Dipanjan Das wrote:
> Hi,
> 
> Like there is section #2 of man pages dedicated to syscalls, is there any
> official way to get the list of all supported Kernal APIs?

check out the man page for man itself (man man)

look for this:

9   Kernel routines [Non standard]



You may need to install them (man 9 files) as they may not be installed

###### example

john at vega:~/download/koans$ man -k printk
printk (9)           - print a kernel message
printk_timed_ratelimit (9) - caller-controlled printk ratelimiting
snd_printd (9)       - debug printk
snd_printdd (9)      - debug printk
snd_printk (9)       - printk wrapper
trace_printk (9)     - printf formatting in the ftrace buffer

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Man pages for Kernel API
  2014-06-03 18:19 ` John de la Garza
@ 2014-06-04  8:51   ` navid Rahimi
  2014-06-04 22:19     ` Frank Ch. Eigler
  0 siblings, 1 reply; 6+ messages in thread
From: navid Rahimi @ 2014-06-04  8:51 UTC (permalink / raw)
  To: kernelnewbies

i dont know which distro you ( Dipanjan Das ) using , but in fedora i
should use something like this for kmalloc :

??[?]?[13:18:11]?[navid at HOME]
???> ~ $ >> man -k kmalloc
probe::vm.kmalloc (3stap) - Fires when kmalloc is requested
probe::vm.kmalloc_node (3stap) - Fires when kmalloc_node is requested
??[13:18:12]?[navid at HOME]
???> ~ $ >> man probe::vm.kmalloc

seems man files divided to probe and subsystem vm and functions.
if you cannot find yet,  you should ask your distro IRC/mailing list
to what to do next.

best wishes,
-navid


On Tue, Jun 3, 2014 at 10:49 PM, John de la Garza <john@jjdev.com> wrote:
> On Tue, Jun 03, 2014 at 10:12:24AM +0530, Dipanjan Das wrote:
>> Hi,
>>
>> Like there is section #2 of man pages dedicated to syscalls, is there any
>> official way to get the list of all supported Kernal APIs?
>
> check out the man page for man itself (man man)
>
> look for this:
>
> 9   Kernel routines [Non standard]
>
>
>
> You may need to install them (man 9 files) as they may not be installed
>
> ###### example
>
> john at vega:~/download/koans$ man -k printk
> printk (9)           - print a kernel message
> printk_timed_ratelimit (9) - caller-controlled printk ratelimiting
> snd_printd (9)       - debug printk
> snd_printdd (9)      - debug printk
> snd_printk (9)       - printk wrapper
> trace_printk (9)     - printf formatting in the ftrace buffer
>
>
> _______________________________________________
> Kernelnewbies mailing list
> Kernelnewbies at kernelnewbies.org
> http://lists.kernelnewbies.org/mailman/listinfo/kernelnewbies

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Man pages for Kernel API
  2014-06-04  8:51   ` navid Rahimi
@ 2014-06-04 22:19     ` Frank Ch. Eigler
  2014-06-05  0:14       ` navid Rahimi
  0 siblings, 1 reply; 6+ messages in thread
From: Frank Ch. Eigler @ 2014-06-04 22:19 UTC (permalink / raw)
  To: kernelnewbies


navid Rahimi <rahimi.nv@gmail.com> writes:

> probe::vm.kmalloc (3stap) - Fires when kmalloc is requested
> probe::vm.kmalloc_node (3stap) - Fires when kmalloc_node is requested

Those are systemtap man pages, not kernel API ones.

- FChE

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Man pages for Kernel API
  2014-06-04 22:19     ` Frank Ch. Eigler
@ 2014-06-05  0:14       ` navid Rahimi
  2014-06-05 15:52         ` navid Rahimi
  0 siblings, 1 reply; 6+ messages in thread
From: navid Rahimi @ 2014-06-05  0:14 UTC (permalink / raw)
  To: kernelnewbies

thank you frank , for make this clear .
so frank in this case can you be more specific , what should i do ?
for example i installed kernel-doc , even downloaded kernel man page
from kernel.org and completed make install routine . but , for example
i don't have any kmalloc man page yet in my fedora . last time i was
in arch linux , i had it .

best wishes,
-navid


On Thu, Jun 5, 2014 at 2:49 AM, Frank Ch. Eigler <fche@redhat.com> wrote:
>
> navid Rahimi <rahimi.nv@gmail.com> writes:
>
>> probe::vm.kmalloc (3stap) - Fires when kmalloc is requested
>> probe::vm.kmalloc_node (3stap) - Fires when kmalloc_node is requested
>
> Those are systemtap man pages, not kernel API ones.
>
> - FChE

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Man pages for Kernel API
  2014-06-05  0:14       ` navid Rahimi
@ 2014-06-05 15:52         ` navid Rahimi
  0 siblings, 0 replies; 6+ messages in thread
From: navid Rahimi @ 2014-06-05 15:52 UTC (permalink / raw)
  To: kernelnewbies

ok . i figure it out .
you should have have have kernel source tree ( which i think most of us had).
any way if you dont :

$git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
$cd linux
$make mandocs
#make installmandocs
#mandb

(and yes you should have xmlto and other package installed )

i hope this will help.


best wishes,
-navid


On Thu, Jun 5, 2014 at 4:44 AM, navid Rahimi <rahimi.nv@gmail.com> wrote:
> thank you frank , for make this clear .
> so frank in this case can you be more specific , what should i do ?
> for example i installed kernel-doc , even downloaded kernel man page
> from kernel.org and completed make install routine . but , for example
> i don't have any kmalloc man page yet in my fedora . last time i was
> in arch linux , i had it .
>
> best wishes,
> -navid
>
>
> On Thu, Jun 5, 2014 at 2:49 AM, Frank Ch. Eigler <fche@redhat.com> wrote:
>>
>> navid Rahimi <rahimi.nv@gmail.com> writes:
>>
>>> probe::vm.kmalloc (3stap) - Fires when kmalloc is requested
>>> probe::vm.kmalloc_node (3stap) - Fires when kmalloc_node is requested
>>
>> Those are systemtap man pages, not kernel API ones.
>>
>> - FChE

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2014-06-05 15:52 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-06-03  4:42 Man pages for Kernel API Dipanjan Das
2014-06-03 18:19 ` John de la Garza
2014-06-04  8:51   ` navid Rahimi
2014-06-04 22:19     ` Frank Ch. Eigler
2014-06-05  0:14       ` navid Rahimi
2014-06-05 15:52         ` navid Rahimi

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).