actions.tcl File Reference

Go to the source code of this file.

Functions/Subroutines
ret	_null (type args)
ret	_tcl (type module, type libdir)
ret	_tcr (type module, type libdir)
ret	_doc (type module, type libdir)
ret	_msg (type module, type libdir)
ret	_tex (type module, type libdir)
ret	_tci (type module, type libdir)
ret	_manfile (type f, type format, type ext, type docdir)
ret	_man (type module, type format, type ext, type docdir)
ret	_exa (type module, type exadir)

---

Function Documentation

ret _doc	(	type	module,
		type	libdir
	)

Definition at line 29 of file actions.tcl.

References _tcl(), file(), and global().

                                      {
    global distribution

    _tcl $module $libdir
    xcopy \
        [file join $distribution modules $module mpformats] \
        [file join $libdir $module mpformats] \
        1
    return
}

Here is the call graph for this function:

ret _exa	(	type	module,
		type	exadir
	)

Definition at line 232 of file actions.tcl.

                                      {
    global distribution
    xcopy \
        [file join $distribution examples $module] \
        [file join $exadir $module] \
        1
    return
}

ret _man	(	type	module,
		type	format,
		type	ext,
		type	docdir
	)

Definition at line 185 of file actions.tcl.

                                                               {
    global distribution argv argc argv0 config

    # [SF Tcllib Bug 784519]
    # Directly access the bundled doctools package to ensure that
    # we have the truly latest code for that, and not the doctools
    # the executing tclsh would find on its own. The present query is
    # used to ensure that we load the package only once.

    #package require doctools
    if {[catch {package present doctools}]} {
    uplevel #0 [list source [file join $distribution modules doctools doctools.tcl]]
    }
    ::doctools::new dt -format $format -module $module

    foreach f [glob -nocomplain [file join $distribution modules $module *.man]] {

    set out [file join $docdir [file rootname [file tail $f]]].$ext

    log "Generating $out"
    if {$config(dry)} {continue}

    dt configure -file $f
    file mkdir [file dirname $out]

    set data [dt format [get_input $f]]
    switch -exact -- $format {
        nroff {
        set data [string map \
            [list \
            {.so man.macros} \
            $config(man.macros)] \
            $data]
        }
        html {}
    }
    write_out $out $data

    set warnings [dt warnings]
    if {[llength $warnings] > 0} {
        log [join $warnings \n]
    }
    }
    dt destroy
    return
}

ret _manfile	(	type	f,
		type	format,
		type	ext,
		type	docdir
	)

Definition at line 147 of file actions.tcl.

                                                              {
    global distribution argv argc argv0 config

    set out [file join $docdir [file rootname [file tail $f]]].$ext

    log "Generating $out"
    if {$config(dry)} return

    if {[catch {package present doctools}]} {
    uplevel #0 [list source [file join $distribution modules doctools doctools.tcl]]
    }

    ::doctools::new dt -format $format -file $f

    file mkdir [file dirname $out]

    set data [dt format [get_input $f]]
    switch -exact -- $format {
    nroff {
        set data [string map \
            [list \
            {.so man.macros} \
            $config(man.macros)] \
            $data]
    }
    html {}
    }
    write_out $out $data

    set warnings [dt warnings]
    if {[llength $warnings] > 0} {
    log [join $warnings \n]
    }

    dt destroy
    return
}

ret _msg	(	type	module,
		type	libdir
	)

Definition at line 40 of file actions.tcl.

References _tcl(), file(), and global().

                                      {
    global distribution

    _tcl $module $libdir
    xcopy \
        [file join $distribution modules $module msgs] \
        [file join $libdir $module msgs] \
        1
    return
}

Here is the call graph for this function:

ret _null

(

type

args

)

Definition at line 9 of file actions.tcl.

{}

ret _tci	(	type	module,
		type	libdir
	)

Definition at line 62 of file actions.tcl.

References _tcl(), file(), and global().

                                      {
    global distribution

    _tcl $module $libdir
    xcopyfile [file join $distribution modules $module tclIndex] \
        [file join $libdir $module]
    return
}

Here is the call graph for this function:

ret _tcl	(	type	module,
		type	libdir
	)

Definition at line 11 of file actions.tcl.

References file(), and global().

Referenced by _doc(), _msg(), _tci(), and _tex().

                                      {
    global distribution
    xcopy \
        [file join $distribution modules $module] \
        [file join $libdir $module] \
        0 *.tcl
    return
}

Here is the call graph for this function:

Here is the caller graph for this function:

ret _tcr	(	type	module,
		type	libdir
	)

Definition at line 20 of file actions.tcl.

References file(), and global().

                                      {
    global distribution
    xcopy \
        [file join $distribution modules $module] \
        [file join $libdir $module] \
        1 *.tcl
    return
}

Here is the call graph for this function:

ret _tex	(	type	module,
		type	libdir
	)

Definition at line 51 of file actions.tcl.

References _tcl(), file(), and global().

                                      {
    global distribution

    _tcl $module $libdir
    xcopy \
        [file join $distribution modules $module] \
        [file join $libdir $module] \
        0 *.tex
    return
}

Here is the call graph for this function: