xref: /titanic_51/usr/src/lib/libast/common/man/fmt.3 (revision b9bd317cda1afb3a01f4812de73e8cec888cbbd7)
.fp 5 CW .. .nr ;G \\n(.f .Af "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" "\\$7" "\\$8" "\\$9" \\*(;G .. .aF 5 \\n(.f "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" "\\$7" .. .aF 5 1 "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" "\\$7" .. .aF 1 5 "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" "\\$7" ..

0

..

..

FMT 3
NAME
fmt - string formatting routines
SYNOPSIS
#include <ast.h> #include <ls.h> char* fmtbase(long number, int base, int prefix); char* fmtdev(struct stat* st); char* fmtelapsed(unsigned long count, int persec) char* fmterror(int errno); char* fmtesc(const char* string); char* fmtfs(struct stat* st); char* fmtgid(int gid); char* fmtmatch(const char* re); char* fmtmode(int mode, int external); char* fmtperm(int perm); char* fmtre(const char* pattern); char* fmtsignal(int sig); char* fmttime(const char* format, time_t tm); char* fmtuid(int uid);
DESCRIPTION
These routines return a pointer to a formatted string for various numeric and string entities. Some routines may cache information to speed up the next call. Most of the routines return a pointer to a private buffer, the contents of which are overwritten on the next call to that routine. Most .L fmt routines have a corresponding .L str routine that converts in the other direction. There is nothing spectacular about this collection other than that it provides a single place where the exact format is spelled out.

.L fmtbase formats a base base representation for number . If "prefix != 0" then the base prefix is included in the formatted string. If "number == 0" or "base == 0" then the output is signed base 10.

.L fmtdev returns the device handle name specified by the .L stat structure st . This is the device information displayed by "ls -l" .

.L fmtelapsed formats the elapsed time for (count/persec) seconds. The two largest time units are used, limiting the return value length to at most 6 characters. The units are:

s seconds

m minutes

h hours

days

weeks

M months

Y years

S scores

.L fmterror returns the system error message text for the error number errno .

.L fmtesc formats non-ASCII characters in string into C-style \e sequences. These sequences are understood by .L chresc and .LR chrtoi .

.L fmtfs returns the file system type name corresponding to the .L stat structure st .

.L fmtgid returns the group name for gid .

.L fmtmatch returns the .L strmatch equivalent pattern for the regular expression pattern re . 0 is returned for invalid re .

.L fmtmode returns the "ls -l" mode string for the file mode bits in mode . If "external != 0" then mode is modecanon (3) canonical.

.L fmtperm returns the chmod permission string for the permission bits in perm .

.L fmtre returns the regular expression equivalent pattern for the .L strmatch pattern pattern . 0 is returned for invalid pattern .

.L fmtsignal returns the signal name, sans .LR SIG , for the signal number sig . If "sig < 0" then the description text for -sig is returned.

.L fmttime returns the results of "tmfmt(buf,sizeof(buf),format,tm)" in the private buffer buf .

.L fmtuid returns the user name for uid .

"SEE ALSO"
modecanon(3), str(3)