.\" -*- coding: us-ascii -*-
.if \n(.g .ds T< \\FC
.if \n(.g .ds T> \\F[\n[.fam]]
.de URL
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
.TH megatools-df 1 "1 November 2024" "" ""
.SH NAME
megatools df \- Show total available, used, or free space in the cloud
.SH SYNOPSIS
.RS 
.nf
\fImegatools df\fR [\-\-free|\-\-total|\-\-used] [\-\-mb|\-\-gb|\-h]
.fi
.RE
.SH DESCRIPTION
Shows available, used and free space in the cloud in machine or human readable
formats.
.SH OPTIONS
.TP 
--total 
Show only total available space (free + used).
.TP 
--free 
Show only free space.
.TP 
--used 
Show only used space.
.TP 
--human , -h 
Display file sizes in a human readable format.
.TP 
--mb 
Show in MiB units.
.TP 
--gb 
Show in GiB units.
.TP 
-u <email> , --username <email> 
Account username (email)
.TP 
-p <password> , --password <password> 
Account password
.TP 
--no-ask-password 
Never ask interactively for a password
.TP 
--reload 
Reload filesystem cache
.TP 
--limit-speed <speed> 
Set maximum allowed upload and download speed in KiB/s.
This option overrides config file settings. 0 means no limit.
When using ParallelTransfers > 1, upload speed limit is applied
to each transfer individually.
.TP 
--proxy <proxy> 
Use proxy server to connect to mega.nz. This option overrides
config file settings.
More information can be found in libcurl documentation at
\(lahttps://curl.haxx.se/libcurl/c/CURLOPT_PROXY.html\(ra.
Some acceptable values are:
.RS 
.TP 0.2i
\(bu
\*(T<none\*(T> : Disable proxy if it was enabled in the config file.
.TP 0.2i
\(bu
\*(T<socks5://localhost:9050\*(T> : Local SOCKSv5 proxy server
.TP 0.2i
\(bu
\*(T<socks5h://localhost:9050\*(T> : Local SOCKSv5 proxy server with DNS handled by the proxy
.RE
.TP 
--netif <ifname|ip> 
Network interface or local IP address used for outgoing connections.
You have to specify IP address bound to some of your local network interfaces, when specifying an IP address.
.TP 
--ip-proto <proto> 
Which IP protocol to prefer when connecting to mega.nz (v4, v6, or any).
This is just an advisory option.
Megatools will resolve mega.nz domain, and then use an A or AAAA record based on the stated preference.
.TP 
--config <path> 
Load configuration from a file
.TP 
--ignore-config-file 
Disable loading .megarc
.TP 
--debug [<options>] 
Enable debugging of various aspects of the megatools
operation. You may enable multiple debugging options
separated by commas. (eg. \*(T<\-\-debug api,fs\*(T>)

Available options are:
.RS 
.TP 0.2i
\(bu
\*(T<http\*(T>: Dump HTTP request/response details (can be used to debug connection/proxy issues)
.TP 0.2i
\(bu
\*(T<api\*(T>: Dump Mega.nz API calls
.TP 0.2i
\(bu
\*(T<fs\*(T>: Dump Mega.nz filesystem (may require \*(T<\-\-reload\*(T> to actually print something)
.TP 0.2i
\(bu
\*(T<cache\*(T>: Dump cache contents
.TP 0.2i
\(bu
\*(T<tman\*(T>: Dump transfer manager events
.RE
.TP 
--version 
Show version information
.SH EXAMPLES
.TP 0.2i
\(bu
Show overall human readable space usage information:

.nf
\*(T<$ megatools df \-h
Total: 50.0 GiB
Used:  6.4 GiB
Free:  43.6 GiB\*(T>
.fi
.TP 0.2i
\(bu
Check free space from a script:

.nf
\*(T<$ test `megatools df \-\-free \-\-gb` \-lt 1 && \e
  echo "You have less than 1 GiB of available free space"\*(T>
.fi
.SH "KNOWN BUGS"
Megadf can\(cqt determine available space for premium accounts.
.SH "SEE ALSO"
\fBmegatools\fR(1),
\fBmegarc\fR(5),
\fBmegatools-df\fR(1),
\fBmegatools-dl\fR(1),
\fBmegatools-get\fR(1),
\fBmegatools-ls\fR(1),
\fBmegatools-mkdir\fR(1),
\fBmegatools-put\fR(1),
\fBmegatools-reg\fR(1),
\fBmegatools-rm\fR(1),
\fBmegatools-copy\fR(1).
.SH MEGATOOLS
Part of the \fBmegatools\fR(1) suite of commands.
.SH BUGS
Report bugs to 
.URL mailto:megatools@megous.com megatools@megous.com
\&. Your message will end up in a public
archive, so be careful what you say or send.
.SH AUTHOR
Megatools was written by Ondrej Jirman <
.URL mailto:megatools@megous.com megatools@megous.com
>, 2013-2022.
.PP
Official website is \(lahttp://megatools.megous.com\(ra.