<commit_before>REQUIREMESTS
	* bash
	* perl with URI::Escape module

INSTALLATION
	1. Place pfsense2-backup.sh in program directory. i.e. /usr/local/bin or /opt/bin
	2. Make sure pfsense2-backup.sh is executable
	3. Copy to pfsense2-backup.example.conf to configuration location (default: /etc/pfsense2-backup.conf)
	4. MAKE SURE PERMISSIONS OF pfsense2-backup.conf ARE SECURE. i.e. chmod 0600
	
CONFIGURATION
	* Edit configuration file

		- Required Parameters - 
		PFSHOSTNAME={pfSense IP/Hostname}
		PFSUSER={pfSense webConfigurator username}
		PFSPASS={pfSense webConfigurator password}

		- Optional parameters -
		BACKUPDIR={directory to store backups}

PARAMETERS
	-c {FILE}   Location of configuration file
	-o          Outputs generated backup file to STDOUT on completion
	            This is useful for passing off to other scripts

USAGE
	To run: pfsense2-backup.sh -c ${CONFIGFILE}
	  Example: pfsense2-backup.sh -c /etc/pfsense2-backup.conf
  
<commit_msg>Added "'" to configuration file documentation for proper escaping of password. <commit_after>REQUIREMESTS
	* bash
	* perl with URI::Escape module

INSTALLATION
	1. Place pfsense2-backup.sh in program directory. i.e. /usr/local/bin or /opt/bin
	2. Make sure pfsense2-backup.sh is executable
	3. Copy to pfsense2-backup.example.conf to configuration location (default: /etc/pfsense2-backup.conf)
	4. MAKE SURE PERMISSIONS OF pfsense2-backup.conf ARE SECURE. i.e. chmod 0600
	
CONFIGURATION
	* Edit configuration file

		- Required Parameters - 
		PFSHOSTNAME='{pfSense IP/Hostname}'
		PFSUSER='{pfSense webConfigurator username}'
		PFSPASS='{pfSense webConfigurator password}'

		- Optional parameters -
		BACKUPDIR='{directory to store backups}'

PARAMETERS
	-c {FILE}   Location of configuration file
	-o          Outputs generated backup file to STDOUT on completion
	            This is useful for passing off to other scripts

USAGE
	To run: pfsense2-backup.sh -c ${CONFIGFILE}
	  Example: pfsense2-backup.sh -c /etc/pfsense2-backup.conf
  

{'fraction_non_alphanumeric': 0.0804369414101291, 'fraction_numerical': 0.015888778550148957, 'mean_word_length': 3.653579676674365, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1392118', 'n_tokens_mistral': 696, 'n_tokens_neox': 658, 'n_words': 206}