A
          / \      _             Play Now                         Nemesis on 
          | |     | |  _______   _        _   _______    _______   _    _______
          | |\    | | |   ____| |  \    /  | |   ____|  /   ____| | |  /   ____|
 /-------/-------------------------------------------------------------------,
O= Home <=XX|  About  News  Pics  Adventurers  Wizards  Download  Connect     >
 \-------\-------------------------------------------------------------------'
          | |   \   | |  |____  | |      | | |  |____   ___ \  \  | |  ___ \  \
          | |     \_| |_______| |_|      |_| |_______| |_______/  |_| |_______/
          \ /
           V  

Documentation Area

Document Path: /doc/lib/neat_file

Simul efun: neat_file - returns a path with the "~" notation

Synopsis:
	string neat_file(mixed object)

Description:
	Replaces "players/wiz/..." by "~wiz/..." for neat display purposes.
	Does not implicate real_file(object).
	Argument can either be an object or its filename (string).

Return value:
	returns a file (or object) path shortened with ~ if possible

Examples:
	neat_file("players/snake/castle" returns "~snake/castle"
	neat_file(find_living("biker")) might return "~snake/obj/biker#63758"
	neat_file(find_player("snake")) might return "obj/wizard#42817"
	
Note:
	It works only for filenames WITHOUT leading slash and returns such.
	The "~" notation only works on the "shell" in Nemesis - when you
	are logged in. It does NOT work in LPC code!

See also:
lib/slash_neat_file
efun/file_name
lib/real_file