From 0ba94d1cfa4bdf92adcc5794f273e02c74a9cfb7 Mon Sep 17 00:00:00 2001 From: Guy Harris Date: Sun, 22 Aug 2010 15:26:35 -0700 Subject: [PATCH] Consistently use "link-layer header type". Use "link-layer header type" as the term for DLT_ values; it doesn't necessarily correspond to the actual data link type of the device (802.11 devices, for example, can supply Ethernet headers). --- pcap_datalink.3pcap.in | 4 ++-- pcap_datalink_name_to_val.3pcap | 8 ++++---- pcap_datalink_val_to_name.3pcap | 10 +++++----- pcap_list_datalinks.3pcap.in | 10 +++++----- pcap_set_datalink.3pcap | 2 +- 5 files changed, 17 insertions(+), 17 deletions(-) diff --git a/pcap_datalink.3pcap.in b/pcap_datalink.3pcap.in index cdc7c24..3d4ace1 100644 --- a/pcap_datalink.3pcap.in +++ b/pcap_datalink.3pcap.in @@ -19,7 +19,7 @@ .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. .\" -.TH PCAP_DATALINK 3PCAP "5 April 2008" +.TH PCAP_DATALINK 3PCAP "22 August 2010" .SH NAME pcap_datalink \- get the link-layer header type .SH SYNOPSIS @@ -34,7 +34,7 @@ int pcap_datalink(pcap_t *p); .fi .SH DESCRIPTION .B pcap_datalink() -returns the link layer type for the live capture or ``savefile'' +returns the link-layer header type for the live capture or ``savefile'' specified by .IR p . .SH SEE ALSO diff --git a/pcap_datalink_name_to_val.3pcap b/pcap_datalink_name_to_val.3pcap index 93daafd..9c8e18a 100644 --- a/pcap_datalink_name_to_val.3pcap +++ b/pcap_datalink_name_to_val.3pcap @@ -19,7 +19,7 @@ .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. .\" -.TH PCAP_DATALINK_NAME_TO_VAL 3PCAP "5 April 2008" +.TH PCAP_DATALINK_NAME_TO_VAL 3PCAP "22 August 2010" .SH NAME pcap_datalink_name_to_val \- get the link-layer header type value corresponding to a header type name @@ -35,12 +35,12 @@ int pcap_datalink_name_to_val(const char *name); .fi .SH DESCRIPTION .B pcap_datalink_name_to_val() -translates a data link type name, which is a +translates a link-layer header type name, which is a .B DLT_ name with the .B DLT_ -removed, to the corresponding data link type value. The translation -is case-insensitive. +removed, to the corresponding link-layer header type value. The +translation is case-insensitive. .SH RETURN VALUE .B pcap_datalink_name_to_val() returns 0 on success and \-1 on failure. diff --git a/pcap_datalink_val_to_name.3pcap b/pcap_datalink_val_to_name.3pcap index 5e4f6bc..26397fa 100644 --- a/pcap_datalink_val_to_name.3pcap +++ b/pcap_datalink_val_to_name.3pcap @@ -19,7 +19,7 @@ .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. .\" -.TH PCAP_DATALINK_VAL_TO_NAME 3PCAP "24 December 2008" +.TH PCAP_DATALINK_VAL_TO_NAME 3PCAP "22 August 2010" .SH NAME pcap_datalink_val_to_name, pcap_datalink_val_to_description \- get a name or description for a link-layer header type value @@ -36,9 +36,9 @@ const char *pcap_datalink_val_to_description(int dlt); .fi .SH DESCRIPTION .B pcap_datalink_val_to_name() -translates a data link type value to the corresponding data link type -name. NULL is returned on failure. +translates a link-layer header type value to the corresponding +link-layer header type name. NULL is returned on failure. .PP .B pcap_datalink_val_to_description() -translates a data link type value to a short description of that data -link type. NULL is returned on failure. +translates a link-layer header type value to a short description of that +link-layer header type. NULL is returned on failure. diff --git a/pcap_list_datalinks.3pcap.in b/pcap_list_datalinks.3pcap.in index eb91c27..6327576 100644 --- a/pcap_list_datalinks.3pcap.in +++ b/pcap_list_datalinks.3pcap.in @@ -36,8 +36,8 @@ void pcap_free_datalinks(int *dlt_list); .fi .SH DESCRIPTION .B pcap_list_datalinks() -is used to get a list of the supported data link types of the interface -associated with the pcap descriptor. +is used to get a list of the supported link-layer header types of the +interface associated with the pcap descriptor. .B pcap_list_datalinks() allocates an array to hold the list and sets .IR *dlt_buf @@ -45,12 +45,12 @@ to point to that array. .LP The caller is responsible for freeing the array with .BR pcap_free_datalinks() , -which frees the list of data links pointed to by +which frees the list of link-layer header types pointed to by .IR dlt_list . .SH RETURN VALUE .B pcap_list_datalinks() -returns the number of data link types in the array on success and \-1 -on failure. +returns the number of link-layer header types in the array on success +and \-1 on failure. If \-1 is returned, .B pcap_geterr() or diff --git a/pcap_set_datalink.3pcap b/pcap_set_datalink.3pcap index b3b54ee..9af32d0 100644 --- a/pcap_set_datalink.3pcap +++ b/pcap_set_datalink.3pcap @@ -35,7 +35,7 @@ int pcap_set_datalink(pcap_t *p, int dlt); .fi .SH DESCRIPTION .B pcap_set_datalink() -is used to set the current data link type of the pcap descriptor +is used to set the current link-layer header type of the pcap descriptor to the type specified by .IR dlt . .SH RETURN VALUE