Version 1.34

Author: josephpaul0

Changelog

@@ -1,3 +1,12 @@
+2020-06-10  Version 1.34
+	* Add manual in PDF
+	* Add support for FreeBSD 11
+	* Show scanning progress with colours on a tty
+	* Detect when output is redirected to a file
+	* [Windows] Maximize console window
+	* Add support for SSH in non-interactive mode (no tty)
+	* Tested with i386, Amd64, and ARM (Raspberry Pi 3)
+
 2019-05-12  Version 1.32
 	* Fix incorrect truncation of long filenames
 	* Add option to print sizes in human readable format

README.md

@@ -33,6 +33,10 @@ Usage: tdu [options] [directory]
 ```
 ##Quick start guide for end users
 - If you just want to use the program on Linux or Windows x86-64, then you can download a ready-to-run binary at https://bitbucket.org/josephpaul0/tdu/downloads/
+- On the "Downloads" page, you will find packages for:
+	- Linux (386, Amd64, Armv6), including Raspberry Pi.
+	- Windows 7, 8, 10 (386, Amd64)
+	- FreeBSD 11 (386, Amd64)
 
 ##Quick start guide for advanced users / developers
 - You need a Go compiler

doc/tdu.1

@@ -1,4 +1,4 @@
-.TH TDU 1 "2019-05-12" "1.32" "Top Disk Usage manual"
+.TH TDU 1 "2020-06-10" "1.34" "Top Disk Usage manual"
 
 .SH NAME
 tdu \- get information about largest files and directories
@@ -13,9 +13,9 @@ It is written in Go and is inspired by the well-known UNIX
 .B du
 command.
 .PP
-
-It scans recursively all subdirectories starting at <directory> or at current
-directory by default.
+It scans recursively all subdirectories starting at <directory>
+.br
+or at current directory by default.
 
 .SH FEATURES
 * Counts files, directories, links, sockets, pipes.
@@ -76,7 +76,7 @@ Does not cross filesystem boundaries. It behaves like
 .B du \-skx
 
 .SH COPYRIGHT
-Copyright \(co 2019 Joseph Paul <joseph.paul1@gmx.com>.
+Copyright \(co 2019,2020 Joseph Paul <joseph.paul1@gmx.com>.
 .br
 License GPLv2+: GNU GPL version 2 or later.
 

tdu.go

@@ -38,7 +38,7 @@ import (
 )
 
 const (
-	prg_VERSION       = "1.32"
+	prg_VERSION       = "1.34"
 	dft_MAXSHOWNLINES = 15
 	dft_MAXEMPTYDIRS  = 0
 	dft_MAXDENIEDDIRS = 0
@@ -91,6 +91,7 @@ type s_scan struct { // Global variables
 	maxPathLen    int64    // maximum directory path length
 	maxFNameLen   int64    // maximum filename length
 	currentDevice uint64   // device number of current partition
+	refreshDelay  int64    // delay between progress bar updates
 	maxWidth      int      // display width (tty columns)
 	maxNameLen    int      // max filename length for depth = 1
 	maxShownLines int      // number of depth 1 items to display
@@ -105,6 +106,7 @@ type s_scan struct { // Global variables
 	foundBoundary bool     // found other filesystems
 	showMax       bool     // show deepest and longest paths
 	export        bool     // export result to Ncdu's JSON format
+	tty           bool     // stdout is on a TTY
 	humanReadable bool     // print sizes in human readable format
 	exportPath    string   // path to exported file
 	exportFile    *os.File // exported file
@@ -126,6 +128,7 @@ type s_scan struct { // Global variables
 	start         time.Time // time at process start
 	msg           chan string
 	done          chan bool
+	sys           interface{} // OS functions
 }
 
 func detectOS(sc *s_scan) {
@@ -147,7 +150,7 @@ func detectOS(sc *s_scan) {
 
 func getConsoleWidth(sc *s_scan) {
 	sc.maxWidth = 80
-	w := getTtyWidth()
+	w := getTtyWidth(sc)
 	if w >= 72 {
 		if w <= 120 {
 			sc.maxWidth = w
@@ -158,13 +161,15 @@ func getConsoleWidth(sc *s_scan) {
 	sc.maxNameLen = sc.maxWidth - 43 // formatting: stay below N columns
 }
 
-func newScanStruct(start time.Time) *s_scan {
+func newScanStruct(start time.Time, sys interface{}) *s_scan {
 	var sc s_scan
 	sc.pathSeparator = string(os.PathSeparator)
 	sc.inodes = make(map[uint64]uint16, 256)
 	sc.start = start
 	sc.msg = make(chan string, 32)
 	sc.done = make(chan bool)
+	sc.refreshDelay = cst_PROGRESSBEAT
+	sc.sys = sys
 	return &sc
 }
 
@@ -648,10 +653,6 @@ func changeDir(args []string) (string, error) {
 		dir, _ = os.Getwd()
 		return dir, nil
 	}
-	if len(args) > 1 {
-		e1 := fmt.Errorf("Can only scan one top directory: got %d", len(args))
-		return dir, e1
-	}
 	err := os.Chdir(args[0])
 	if err != nil {
 		e2 := fmt.Errorf("Cannot change directory to %s\n%v", args[0], err)
@@ -668,7 +669,7 @@ func changeDir(args []string) (string, error) {
 func usage(sc *s_scan) []string {
 	flag.Usage = func() {
 		showTitle()
-		fmt.Println(" Copyright (c) 2019 Joseph Paul <joseph.paul1@gmx.com>")
+		fmt.Println(" Copyright (c) 2020 Joseph Paul <joseph.paul1@gmx.com>")
 		fmt.Println(" https://bitbucket.org/josephpaul0/tdu")
 		fmt.Println()
 		fmt.Printf(" Usage: %s [options] [directory]\n", os.Args[0])
@@ -739,6 +740,17 @@ func usage(sc *s_scan) []string {
 		sc.export = true
 		sc.exportPath = *ex
 	}
+	if len(flag.Args()) > 1 {
+		fmt.Println()
+		fmt.Printf("[ERROR] can only scan one top directory: got %d", len(args))
+		fmt.Println()
+		fmt.Println()
+		fmt.Println("[TIP] Use double-quotes around the directory path if it contains spaces.")
+		fmt.Println("[TIP] Example: tdu.exe \"C:\\Program Files\"")
+		fmt.Println()
+		flag.Usage()
+		os.Exit(2)
+	}
 	return args
 }
 
@@ -751,8 +763,9 @@ func showProgress(sc *s_scan) {
 	var i int
 	var m string
 	space := strings.Repeat(" ", 42)
+	fmt.Println()
 	for {
-		time.Sleep(cst_PROGRESSBEAT * time.Millisecond)
+		time.Sleep(time.Duration(sc.refreshDelay) * time.Millisecond)
 		select {
 		case m = <-sc.msg:
 			fmt.Print(space)
@@ -762,8 +775,7 @@ func showProgress(sc *s_scan) {
 			}
 		default:
 			i++
-			n := sc.nErrors + sc.nItems
-			fmt.Printf("  [.... scanning... %6d  ....]\r", n)
+			printProgress(sc)
 		}
 		if m == cst_ENDPROGRESS {
 			break
@@ -774,8 +786,10 @@ func showProgress(sc *s_scan) {
 }
 
 func endProgress(sc *s_scan) {
-	sc.msg <- cst_ENDPROGRESS
-	<-sc.done
+	if sc.tty {
+		sc.msg <- cst_ENDPROGRESS
+		<-sc.done
+	}
 }
 
 func push(sc *s_scan, msg string) {
@@ -790,7 +804,7 @@ func showTitle() {
 	fmt.Println()
 }
 
-func relocate(args []string) string {
+func relocate(sc *s_scan, args []string) string {
 	d, err := changeDir(flag.Args())
 	if err != nil {
 		showTitle()
@@ -801,37 +815,49 @@ func relocate(args []string) string {
 	return d
 }
 
+func showResults(sc *s_scan, fi []file, total *file) {
+	show(sc, fi, total) // Step 3
+	showmax(sc, total)  // step 4
+	showempty(sc)
+	showdenied(sc)
+	showerrors(sc)
+	showstreams(sc)
+	showdevices(sc)
+}
+
+func startProgress(sc *s_scan) {
+	if sc.tty {
+		go showProgress(sc)
+	} else {
+		fmt.Fprintln(os.Stderr, "  Please wait...")
+	}
+}
+
 /* Basically, the process has got several steps:
  * 1. change directory to given path
  * 2. scan all files recursively, collecting 'stat' data
  * 3. sort results and output a list of biggest items at depth 1.
  * 4. show the largest files at any depth.
  */
 func main() {
-	osInit()
+	_, sys := osInit()
 	start := time.Now()
-	sc := newScanStruct(start)
+	sc := newScanStruct(start, sys)
 	args := usage(sc)
-	d := relocate(args) // step 1
+	d := relocate(sc, args) // step 1
 	detectOS(sc)
-	clearTty()
+	initTty(sc)
 	getConsoleWidth(sc)
 	showTitle()
 	fmt.Printf("  OS: %s %s,", sc.os, runtime.GOARCH)
 	fmt.Printf(" scanning [%s]...\n", d)
 	ncduInit(sc)
-	go showProgress(sc)
+	startProgress(sc)
 	var fi []file
 	t, _ := scan(sc, &fi, ".", 1) // Step 2
 	endProgress(sc)
-	show(sc, fi, t) // Step 3
-	showmax(sc, t)  // step 4
-	showempty(sc)
-	showdenied(sc)
-	showerrors(sc)
-	showstreams(sc)
-	showdevices(sc)
+	showResults(sc, fi, t)
 	ncduEnd(sc)
 	showElapsed(sc)
-	osEnd()
+	osEnd(sys)
 }

tdu_bsd.go

@@ -0,0 +1,21 @@
+// +build darwin freebsd
+
+/* Top Disk Usage.
+ * Copyright (C) 2019 Joseph Paul <joseph.paul1@gmx.com>
+ * https://bitbucket.org/josephpaul0/tdu
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ */
+
+package main
+
+import (
+	"syscall"
+)
+
+func tcgets() uintptr {
+	return uintptr(syscall.TIOCGETA)
+}

tdu_generic.go

@@ -1,5 +1,6 @@
 // +build !linux
 // +build !windows
+// +build !freebsd
 
 /* Top Disk Usage.
  * Copyright (C) 2019 Joseph Paul <joseph.paul1@gmx.com>
@@ -15,6 +16,10 @@
 
 package main
 
+import (
+	"fmt"
+)
+
 func osInit() bool {
 	return true
 }
@@ -27,7 +32,12 @@ func getTtyWidth() int {
 	return 80
 }
 
-func clearTty() {} // OS Specific
+func initTty(sc *sc_scan) {} // OS Specific
+
+func printProgress(sc *s_scan) {
+	n := sc.nErrors + sc.nItems
+	fmt.Printf("  [.... scanning... %6d  ....]\r", n)
+}
 
 // Disk usage is inaccurate because appropriate syscall is not yet implemented
 func sysStat(sc *s_scan, f *file) error {