tomo-getenv.3

(34 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH getenv 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 getenv \- get an environment variable
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI getenv\ :\ func(name:\ Text\ ->\ Text?)
  13 .fi
  14 .SH DESCRIPTION
  15 Gets an environment variable.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx
  23 l l l.
  24 Name	Type	Description
  25 name	Text	The name of the environment variable to get. 
  26 .TE
  27 .SH RETURN
  28 If set, the environment variable's value, otherwise, `none`.
  29 
  30 .SH EXAMPLES
  31 .EX
  32 assert getenv("TERM") == "xterm-256color"
  33 assert getenv("not_a_variable") == none
  34 .EE