Changed packaging.
- Drop .yapfaqrc and yapfaq.cfg in favor of .yapfaqrc.sample and yapfaq.cfg.sample; rename test.txt to sample.txt. - Change contents of these files to reflect the new names. - Update some defaults, change sample.txt contents to English. - Add "INSTALLATION" chapter to documentation. Fixes #7. Signed-off-by: Thomas Hochstein <thh@inter.net>
This commit is contained in:
		
							parent
							
								
									8f65a0a519
								
							
						
					
					
						commit
						c4765a39f3
					
				
					 5 changed files with 28 additions and 17 deletions
				
			
		| 
						 | 
					@ -2,5 +2,5 @@ NNTPServer = 'localhost'
 | 
				
			||||||
NNTPUser   = ''
 | 
					NNTPUser   = ''
 | 
				
			||||||
NNTPPass   = ''
 | 
					NNTPPass   = ''
 | 
				
			||||||
Sender     = ''
 | 
					Sender     = ''
 | 
				
			||||||
ConfigFile = 'yapfaq.cfg'
 | 
					ConfigFile = 'yapfaq.cfg.sample'
 | 
				
			||||||
Program    = ''
 | 
					Program    = ''
 | 
				
			||||||
							
								
								
									
										9
									
								
								sample.txt
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										9
									
								
								sample.txt
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
					@ -0,0 +1,9 @@
 | 
				
			||||||
 | 
					Last-modified: 2010-05-15
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					This is a test message.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Foo.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Bar.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					That's quite enought, isn't it?
 | 
				
			||||||
							
								
								
									
										11
									
								
								test.txt
									
										
									
									
									
								
							
							
						
						
									
										11
									
								
								test.txt
									
										
									
									
									
								
							| 
						 | 
					@ -1,11 +0,0 @@
 | 
				
			||||||
Last-modified: 2003-01-11
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Dies ist ein Test-Artikel. Klasse, was?
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Bla.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Noch mehr foo.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Bar.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Nu reicht's.
 | 
					 | 
				
			||||||
| 
						 | 
					@ -1,9 +1,9 @@
 | 
				
			||||||
# name of your project
 | 
					# name of your project
 | 
				
			||||||
Name = 'testpost'
 | 
					Name = 'sample'
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# file to post (complete body and pseudo-headers)
 | 
					# file to post (complete body and pseudo-headers)
 | 
				
			||||||
# ($File.cfg contains data on last posting and last MID)
 | 
					# ($File.cfg contains data on last posting and last MID)
 | 
				
			||||||
File = 'test.txt'
 | 
					File = 'sample.txt'
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# how often your project should be posted
 | 
					# how often your project should be posted
 | 
				
			||||||
# use (d)ay OR (w)eek OR (m)onth OR (y)ear
 | 
					# use (d)ay OR (w)eek OR (m)onth OR (y)ear
 | 
				
			||||||
| 
						 | 
					@ -15,7 +15,7 @@ Posting-frequency = '1d'
 | 
				
			||||||
# Expires = '3m'
 | 
					# Expires = '3m'
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# header "From:"
 | 
					# header "From:"
 | 
				
			||||||
From = 'test@domain.invalid'
 | 
					From = 'John Doe <john-doe@example.com>'
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# header "Subject:"
 | 
					# header "Subject:"
 | 
				
			||||||
# (may contain "%LM" which will be replaced by the contents of the
 | 
					# (may contain "%LM" which will be replaced by the contents of the
 | 
				
			||||||
| 
						 | 
					@ -31,8 +31,8 @@ NGs = 'de.test'
 | 
				
			||||||
# Fup2 = 'poster'
 | 
					# Fup2 = 'poster'
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# Message-ID ("%n" is $Name)
 | 
					# Message-ID ("%n" is $Name)
 | 
				
			||||||
# This setting is optional. Default: <%n-%d.%m.%y@YOURHOST>
 | 
					# This setting is optional. Default: <%n-%y-%m-%d@YOURHOST>
 | 
				
			||||||
# MID-Format = '<%n-%d.%m.%y@domain.invalid>'
 | 
					# MID-Format = '<%n-%y-%m-%d@domain.invalid>'
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# Supersede last posting?
 | 
					# Supersede last posting?
 | 
				
			||||||
# This setting is optional. Default: unset
 | 
					# This setting is optional. Default: unset
 | 
				
			||||||
							
								
								
									
										13
									
								
								yapfaq.pl
									
										
									
									
									
								
							
							
						
						
									
										13
									
								
								yapfaq.pl
									
										
									
									
									
								
							| 
						 | 
					@ -748,6 +748,19 @@ to or load another configuration file defining (an)other FAQ(s).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
=back
 | 
					=back
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					=head1 INSTALLATION
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Just copy the contents of the tarball in some directory and get started.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					You can post your first test with
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					    yapfaq -c .yapfaqrc.sample
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					or copy F<.yapfaqrc.sample> to F<.yapfaqrc> and F<yapfaq.cfg.sample>
 | 
				
			||||||
 | 
					to F<yapfaq.cfg>, edit those files and get really started!
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					=back
 | 
				
			||||||
 | 
					
 | 
				
			||||||
=head1 EXAMPLES
 | 
					=head1 EXAMPLES
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Post all FAQs that are due for posting:
 | 
					Post all FAQs that are due for posting:
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue