I'm tired of updating the help in README
Signed-off-by: fbt <fbt@fleshless.org>
This commit is contained in:
		
							
								
								
									
										33
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										33
									
								
								README.md
									
									
									
									
									
								
							@@ -13,38 +13,11 @@ Scripts
 | 
			
		||||
ufw
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
ufw is the main one, it uploads shit.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
	Usage: ufw [-RsF] [-D num] [file/url]"
 | 
			
		||||
	    Flags:
 | 
			
		||||
	        -R                   # Remove the file after uploading.
 | 
			
		||||
	        -s                   # Make a screenshot and upload it instead of a file.
 | 
			
		||||
	        -F                   # Make a fullscreen shot instead of prompting for a window/area. Implies -s.
 | 
			
		||||
	        -d                   # Supply a dexcription.
 | 
			
		||||
	        -D <num>             # Delay the shot by <num> seconds.
 | 
			
		||||
	        -p                   # Make the file public.
 | 
			
		||||
	        -u                   # Generate a shortlink from URL.
 | 
			
		||||
	        -m                   # Maximum filesize (takes K, M and G suffixes).
 | 
			
		||||
	        -a                   # Add the file to an album.
 | 
			
		||||
	        -A                   # API response format.
 | 
			
		||||
	
 | 
			
		||||
	    Config options (~/.config/ufw):
 | 
			
		||||
	        secret               # Your personal token. Get it at https://zfh.so/settings_form
 | 
			
		||||
	        cfg_screenshot_ext   # Screenshot file type, used by scrot.
 | 
			
		||||
	        cfg_max_filesize     # Maximum filesize in megabytes.
 | 
			
		||||
	        # Others are self-explanatory:
 | 
			
		||||
	        cfg_url_regex
 | 
			
		||||
	        cfg_tmp_dir
 | 
			
		||||
	        cfg_service_url
 | 
			
		||||
ufw can upload files to 8fw.me, shorten urls and show you your ip.
 | 
			
		||||
Call ufw -h for help.
 | 
			
		||||
 | 
			
		||||
ufwd
 | 
			
		||||
----
 | 
			
		||||
 | 
			
		||||
ufwd periodically checks a directory of your choosing (defaults to $XDG_RUNTIME DIR/ufwd) and invokes ufw to upload the files and remove them.
 | 
			
		||||
 | 
			
		||||
	Usage: ufwd [-hn] [-d workdir] -D [check delay] -- [ufw flags]
 | 
			
		||||
	   -h            # Show this message.
 | 
			
		||||
	   -n            # Enable notifications with notify-send. Must be installed.
 | 
			
		||||
	   -d [path]     # Set the dir that is to be watched.
 | 
			
		||||
	   -D [sec]      # Set the check interval.
 | 
			
		||||
Call ufwd -h for help.
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										4
									
								
								ufw
									
									
									
									
									
								
							
							
						
						
									
										4
									
								
								ufw
									
									
									
									
									
								
							@@ -28,10 +28,10 @@ usage() {
 | 
			
		||||
		        -d|--description              # Supply a description.
 | 
			
		||||
		        -D|--screenshot-delay <num>   # Delay the shot by <num> seconds.
 | 
			
		||||
		        -p|--public                   # Make the file public.
 | 
			
		||||
		        -u|--shorten                  # Generate a shortlink from URL.
 | 
			
		||||
		        -u|--shorten <URL>            # Generate a shortlink from URL.
 | 
			
		||||
		        -S|--short-url                # Get a shortlink when uploading a file.
 | 
			
		||||
		        -P|--page-url                 # Get a link to the file page instead of a direct one.
 | 
			
		||||
		        -m|--max-filesize             # Maximum filesize (takes K, M and G suffixes).
 | 
			
		||||
		        -m|--max-filesize <num>[suf]  # Maximum filesize (takes K, M and G suffixes).
 | 
			
		||||
		        -a|--album-id                 # Add the file to an album.
 | 
			
		||||
		        -A|--album-name               # Add the file to an album by name. The album will be crated, if necessary.
 | 
			
		||||
		
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user