[Up] [Index]

1 The Example Package

Sections

  1. The main functions

This chapter describes the GAP package Example. As its name suggests it is an example of how to create a GAP package. It has little functionality except for being a package.

If you are viewing this with on-line help, type:

gap> ?>

to see the functions provided by the Example package.

1.1 The main functions

The following functions are available:

  • ListDirectory([dir]) F

    lists the files in directory dir (a string) or the current directory if called with no arguments.

  • FindFile( directory_name, file_name ) F

    searches for the file file_name in the directory tree rooted at directory_name and returns the absolute path names of all occurrences of this file as a list of strings.

  • LoadedPackages() F

    returns a list with the names of the packages that have been loaded so far.

  • Which( prg ) F

    returns the path of the program executed if Exec(prg); is called, e.g.

    gap> Which("date");         
    "/bin/date"
    gap> Exec("date");
    Sun Oct  7 16:23:45 CEST 2001
    

  • WhereIsPkgProgram( prg ) F

    returns a list of paths of programs with name prg in the current packages loaded. Try:

    gap> WhereIsPkgProgram( "hello" );
    

  • HelloWorld() F

    executes the C program hello provided by the Example package.

    [Up] [Index]

    Example manual
    May 2002