File: delete-dir.2gg

package info (click to toggle)
golf 601.4.41-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,824 kB
  • sloc: ansic: 20,020; sh: 1,171; makefile: 292
file content (41 lines) | stat: -rw-r--r-- 766 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
.TH GOLF 2gg $VERSION $DATE Development Tools
.SH NAME
delete-dir \-  (directories)
.SH PURPOSE
Delete directory.

.SH SYNTAX

.RS 4
.EX

delete-dir <directory> [ status <status> ]

.EE
.RE

.SH DESCRIPTION
delete-dir will delete <directory>, which is a string that may be an absolute or relative path. 

If "status" clause is used, then number <status> is GG_OKAY if succeeded, GG_ERR_EXIST if directory is not empty, or GG_ERR_FAILED for other errors (in which case you can use "errno" clause in \fBget-req\fP to find the specific reason why).

.SH EXAMPLES

.RS 4
.EX

delete-dir "/home/user/some_dir"

.EE
.RE

.SH SEE ALSO
 Directories

\fBchange-dir\fP  
\fBchange-mode\fP  
\fBdelete-dir\fP  
\fBdirectories\fP  
\fBnew-dir\fP   
See all 
\fBdocumentation\fP