sdfapi(1) [debian man page]

SDFAPI(1)						User Contributed Perl Documentation						 SDFAPI(1)

NAME

       sdfapi - API Extraction Utility

PURPOSE

       sdfapi extracts Application Programming Interface information from (Perl) source code.

USAGE

	usage  : sdfapi [-h[help]] [-o[out_ext]]
		[-l[log_ext]] [-O[out_dir]] [-f fmt_tag]
		[-p[pattern]] [-s sym_type,..] [-j]
		file ...
       purpose: extract the API from a (perl) library
       version: 2.000	 (SDF 2.001)

       The options are:

	Option	     Description
	-h	     display help on options
	-o	     output file extension
	-l	     log file extension
	-O	     output to input file's (or explicit) directory
	-f	     output format tag
	-p	     only symbols matching pattern
	-s	     only symbols of these types
	-j	     add SDF-style hypertext jumps from each symbol

DESCRIPTION

       The -h option provides help. If it is specified without a parameter, a brief description of each option is displayed. To display the
       attributes for an option, specify the option letter as a parameter.

       By default, generated output goes to standard output. To direct output to a file per input file, use the -o option to specify an extension
       for output files. If the -o option is specified without a parameter, an extension of out is assumed.

       Likewise, error messages go to standard error by default. Use the -l option to create a log file per input file. If the -l option is
       specified without a parameter, an extension of log is assumed.

       By default, generated output and log files are created in the current directory. Use the -O option to specify an explicit output directory.
       If the -O option is specified without a parameter, the input file's directory is used.

       The format of the output can be controlled using the -f option.	Supported formats are std and concise. The default is std.  std format is:

	require "abc.pl";

       $myvar = ...

       $result = &myfunc($myparams);

       concise format has fewer blank lines and uses 1 line per symbol.

       A comma-separated list of symbol types to output can be specified using the -s option. Supported symbol types are:

       o   sub - subroutines

       o   var - variables

       The default is to extract all symbols.

       The -p option is used to extract only a subset of the symbols. If not supplied, the pattern is symbols beginning with a letter. If supplied
       without an option, the pattern defaults to all symbols. If perl libraries use the coding convention that symbols beginning with underscore
       are private, then -p_ can be used to extract the private symbols.

       The -j option can be used to request SDF-style hypertext jumps be added for each symbol. The jump target is lib_sym where:

       o   lib is the library name

       o   sym is the symbol name.

LIMITATIONS AND FUTURE DIRECTIONS

       The only language currently supported is Perl.

       It would be useful to extract messages from the scripts too. This would require a new utility called sdfmsg say, which searched through the
       source (including libraries) for AppMsg and AppExit calls.

       Internally, it may be better to implement formats via routines. This would give better control over output. e.g. it would be up to the
       routine to decide if it wanted to output the 'require' header.

perl v5.12.4							    2011-11-09								 SDFAPI(1)

NMEDIT(1)						      General Commands Manual							 NMEDIT(1)

NAME

       nmedit - change global symbols to local symbols

SYNOPSIS

       nmedit -s list_file [-R list_file] [-p] [-A] [-] [[-arch arch_type] ...] object_file ... [-o output]

DESCRIPTION

       Nmedit  changes	the  global  symbols not listed in the list_file file of the -s list_file option to static symbols.  Undefined symbols and
       common symbols are not effected and shouldn't be listed in list_file.  For dynamic libraries symbols are turned into private extern symbols
       that  are  no  longer  external (rather than static symbols).  This is done so that the references between modules of a dynamic library are
       resolved to the symbols in the dynamic library.	Nmedit differs from strip(1) in that it also changes the  symbolic  debugging  information
       (produce by the -g option to cc(1)) for the global symbols it changes to static symbols so that the resulting object can still be used with
       the debugger.

       Nmedit like strip(1) is useful to limit the symbols for use with later linking.	This allows control of the interface that  the	executable
       wants  to provide to the objects that it will dynamically load, and it will not have to publish symbols that are not part of its interface.
       For example an executable that wishes to allow only a subset of its global symbols but all of the shared libraries globals to be used would
       have its symbol table edited with:
	      % nmedit -s interface_symbols -A executable
       where  the file interface_symbols would contain only those symbols from the executable that it wishes the objects loaded at runtime to have
       access to.  Another example is an object that is made up of a number of other objects that will be loaded into an  executable  would  built
       and then have its symbol table edited with:
	      % ld -o relocatable.o -r a.o b.o c.o
	      % nmedit -s interface_symbols relocatable.o
       which  would  leave  only  the symbols listed in the file interface_symbols (and the undefined and common symbols) as global symbols in the
       object file.

       The one or more of the following options is required to nmedit(1) is:

       -s filename
	      Leave the symbol table entries for the global symbols listed in filename global but turn all other global symbols (except  undefined
	      and common symbols) into static symbols.	The symbol names listed in filename must be one per line. Leading and trailing white space
	      are not part of the symbol name.	Lines starting with # are ignored, as are lines with only white space.

       -R filename
	      Change the symbol table entries for the global symbols listed in filename into static symbols.  This file has the same format as the
	      -s filename option above.  If the -R filename option is specified without the -s filename option, then all symbols not listed in the
	      -R filename option's filename are left as globals.  If both a -R filename and a -s filename are given the symbols listed in  the	-R
	      filename are basically ignored and only those symbols listed in the -s filename are saved.

       -p     Change  symbols  to  private  externs instead of static.	This is allowed as the only option to change all defined global symbols to
	      private externs.

       The options to nmedit(1) are:

       -A     Leave all global absolute symbols except those with a value of zero, and	save  objective-C  class  symbols  as  globals.   This	is
	      intended for use of programs that load code at runtime and want the loaded code to use symbols from the shared libraries.

       -      Treat all remaining arguments as file names and not options.

       -arch arch_type
	      Specifies  the  architecture,  arch_type, of the file for nmedit(1) to process when the file is a fat file (see arch(3) for the cur-
	      rently know arch_types).	The arch_type can be all to process all architectures in the file.  The default is to process  all  archi-
	      tectures that are contained in the file.

       -o output
	      Write the result into the file output.

SEE ALSO

       strip(1), ld(1), arch(3)

BUGS

       The  changing of the symbolic debugging information by nmedit is not known to be totally correct and could cause the debugger to crash, get
       confused or produce incorrect information.

Apple Computer, Inc.						  March 19, 2002							 NMEDIT(1)