Нет описания
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.

cm-help.en.txt 341KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827
  1. == CMD_DESCRIPTION_ACL ==
  2. Sets permissions on an object.
  3. == CMD_USAGE_ACL ==
  4. Usage:
  5. cm ^acl (--^user=<usr_name> | --^group=<group_name>)
  6. (-^allowed|-^denied|-^overrideallowed|-^overridedenied=+|-<permission>[,...])[,...]
  7. <objectspec>
  8. --^user User name.
  9. --^group Group name.
  10. -^allowed Enables the specified permission or permissions. Use a
  11. comma to separate permissions. (Use 'cm ^showpermissions'
  12. to display all the available permissions.)
  13. -^denied Denies the specified permission or permission. Use a
  14. comma to separate permissions. (Use 'cm ^showpermissions'
  15. to display all the available permissions.)
  16. -^overrideallowed Overrides the allowed permission or permissions. Use a
  17. comma to separate permissions. (Use 'cm ^showpermissions'
  18. to display all the available permissions.)
  19. -^overridedenied Overrides the denied permission or permissions. Use a
  20. comma to separate permissions. (Use 'cm ^showpermissions'
  21. to display all the available permissions.)
  22. objectspec The object whose permissions will be set.
  23. The valid objects for this command are:
  24. repserver, repository, branch, changeset, label, item,
  25. and attribute.
  26. (Use 'cm ^help ^objectspec' to learn more about specs.)
  27. Special usage for secured paths:
  28. cm ^acl [(--^user=<usr_name> | --^group=<group_name>)
  29. (-^allowed|-^denied|-^overrideallowed|-^overridedenied=+|-<permission>[,...])[,...]]
  30. [--^delete] [--^branches=[+ | -]<branch>[,...]]
  31. <spec>
  32. --^delete Removes a secured path.
  33. See Remarks for more info.
  34. --^branches Sets the secured path permissions to a group of branches.
  35. Use a comma to separate branches.
  36. Optionally, each branch can be preceded by the + or -
  37. sign to specify whether a branch must be added or deleted
  38. to the list when editing.
  39. See Remarks for more info.
  40. spec The secured path where to set the permissions.
  41. == CMD_HELP_ACL ==
  42. Configuring permissions requires understanding how Plastic SCM security works.
  43. Check the Security Guide to learn how permissions work:
  44. https://www.plasticscm.com/download/help/securityguide
  45. Remarks:
  46. This command sets permissions for a user or group on the specified objects,
  47. repositories, branches, labels and/or server paths.
  48. Object specs:
  49. (Use 'cm ^help ^objectspec' to learn how to specify objects.)
  50. The '^acl' command uses a special type of spec: secured paths.
  51. - Secured paths specs:
  52. ^path:server_path[#tag]
  53. Examples: ^path:/src/foo.c
  54. ^path:/doc/pdf
  55. ^path:/doc/pdf#documents
  56. Permission action:
  57. Use -^allowed and -^denied to specify what permissions to set.
  58. Use -^overrideallowed and -^overridedenied arguments to specify what
  59. permissions to override.
  60. Each action requires a permission list separated by commas.
  61. Permission names:
  62. Each permission name is preceded by + or - symbol.
  63. The + symbol sets the permission and the - symbol clears it.
  64. To see the permissions of an object, use the 'cm ^showacl' command.
  65. Overridden permissions:
  66. Overriding a permission using -^overrideallowed and -^overridedenied
  67. allows you to bypass inheritance.
  68. It is helpful to bypass permissions set at the repository or server
  69. level.
  70. Example:
  71. cm ^acl --^user=vio -^allowed=+^ci -^overrideallowed=+^ci ^br:qa@test
  72. (Allows user 'vio' to checkin on the branch 'qa' on repo 'test'
  73. even if she has the permission denied at the repo level.)
  74. Server path permissions (a.k.a. secured paths):
  75. - It is possible to specify permissions for a given server path.
  76. - These permissions are checked during the checkin operation.
  77. - These permissions can also be checked during the update operation,
  78. and can be used as a way to prevent certain directories and files to
  79. be downloaded to the workspace.
  80. - For every item to checkin, the server tries to match the item path
  81. with a secured path. If it matches, the checkin operation checks
  82. whether the item has permissions to be checked in.
  83. The permissions that can be defined for a secured path are the
  84. following:
  85. '^ci', '^change', '^add', '^move', '^rm', '^read'
  86. If the permissions check is not successful for any of the involved
  87. items, the checkin operation will be rolled back.
  88. To set secured path permissions to a group of branches, use the
  89. --^branches option.
  90. Example:
  91. cm ^acl --^user=jo -^denied=+^ci ^path:/src#rule0 --^branches=main,main/rel0
  92. To edit the ACL associated to the secured path, the tag is useful.
  93. Example:
  94. cm ^acl --^user=jo -^denied=+^rm ^path:/src#rule0
  95. (Without the tag, the list of branches would need to be specified
  96. again.)
  97. The list of branches of the secured path can be edited.
  98. Example:
  99. cm ^acl ^path:/src#rule0 --^branches=-main,+main/rel1
  100. (Removes 'main' from the list and adds 'main/rel1'.)
  101. To remove a secured path, use the --^delete argument.
  102. Example:
  103. cm ^acl --^user=jo --^delete ^path:/src#rule0
  104. Inheritance:
  105. Inheritance is an option that comes from the days of Plastic SCM 3.0.
  106. It is advanced, but almost deprecated.
  107. It lets an object inherit its permissions from any other object,
  108. overriding the default inheritance relationships.
  109. Use the option -^cut to cut the inheritance chain.
  110. Use the option -^cutncpy to cut and copy the current inherited
  111. permissions. (This is inspired on the Windows filesystem permissions
  112. where you can cut inheritance but retain the actual permissions.)
  113. The -^inherit option allows the user to inherit from an object spec.
  114. Example: '-^inherit=object_spec'
  115. Examples:
  116. cm ^acl --^user=danipen -^denied=+^ci ^rep:core
  117. (Denies checkin for user 'danipen' on repo 'core'.)
  118. cm ^acl --^group=developers -^allowed=+^view,-^read -^denied=+^chgperm ^br:main
  119. (The command grants view permission, clears read permission,
  120. and denies chgperm permission to 'developers' group in 'main' branch.)
  121. Secured path examples:
  122. cm ^acl --^group=devs -^denied=+^ci ^path:/server#rel --^branches=main,main/2.0
  123. (The command denies the checkin permission to 'devs' group for any path
  124. that matches '/server' in the branches 'main' and 'main/2.0'. The tag '#rel'
  125. is created to be able to refer to it later.)
  126. cm ^acl ^path:/server#rel --^branches=-/main,+/main/Rel2.1
  127. (Updates the secured path '/server' whose tag is 'rel', removing the
  128. 'main' branch and adding the branch 'main/Rel2.1' to the branch
  129. group the secured path applies to. Considering the previous example,
  130. now the branches list will contain 'main/Rel2.1' and 'main/2.0'.)
  131. cm ^acl --^user=vsanchezm -^allowed=-^read -^overrideallowed=+^read ^path:/doc
  132. (Removes '^read' permission to 'vsanchezm' overriding it in '/doc' path.)
  133. == CMD_DESCRIPTION_ACTIVATEUSER ==
  134. Activates a licensed user.
  135. == CMD_USAGE_ACTIVATEUSER ==
  136. Usage:
  137. cm ^activateuser | ^au <user-name>[ ...] [--^server=<rep-server-spec>]
  138. user-name The user name or user names to activate. Use double quotes (" ")
  139. to specify user names containing spaces. Use a whitespace to
  140. separate user names.
  141. Options:
  142. --^server=<rep-server-spec> Activates the user in the specified server.
  143. If no server is specified, executes the command
  144. in the default server in the client.conf file.
  145. (Use 'cm ^help ^objectspec' to learn more about
  146. repserver specs.)
  147. == CMD_HELP_ACTIVATEUSER ==
  148. Remarks:
  149. To activate a user, it must have been previously deactivated.
  150. By default, a user is activated the first time they perform a write
  151. operation in Plastic SCM. The user is automatically activated only if
  152. the maximum number of users has not been exceeded.
  153. (See the 'cm ^help ^deactivateuser' command for more information about
  154. deactivating Plastic SCM users.)
  155. Examples:
  156. cm ^activateuser john
  157. cm ^activateuser david "mary collins"
  158. cm ^au peter --^server=localhost:8087
  159. == CMD_DESCRIPTION_ADD ==
  160. Adds an item to version control.
  161. == CMD_USAGE_ADD ==
  162. Usage:
  163. cm ^add [-^R | -^r | --^recursive] [--^silent] [--^ignorefailed]
  164. [--^skipcontentcheck] [--^coparent] [--^filetypes=<file>] [--^noinfo]
  165. [--^format=<str-format>] [--^errorformat=<str-format>]
  166. <item-path>[ ...]
  167. item-path The item or items to add. Use double quotes (" ") to specify
  168. paths containing spaces. Use a whitespace to separate items.
  169. Use * to add all the contents of the current directory.
  170. Options:
  171. -^R -^r --^recursive Adds items recursively.
  172. --^silent Does not show any output.
  173. --^ignorefailed If an item cannot be added, the add operation will
  174. continue without it. Note: If a directory cannot be
  175. added, its content is not added.
  176. --^skipcontentcheck When the extension is not enough to set the file as
  177. text or binary, it will be set as binary instead of
  178. checking the content to detect the type. This is done
  179. to increase performance on huge checkins.
  180. --^coparent Runs a checkout of the parent of the item being added.
  181. --^filetypes The filetypes file to use. Check the following link for
  182. more information:
  183. http://blog.plasticscm.com/2008/03/custom-file-types.html
  184. --^noinfo Doesn't print progress information.
  185. --^format Retrieves the output message in a specific format. Check
  186. the examples for more information.
  187. --^errorformat Retrieves the error message (if any) in a specific
  188. format. Check the examples for more information.
  189. == CMD_HELP_ADD ==
  190. Remarks:
  191. Requirements to add items:
  192. - The parent directory of the item to add must have been previously added.
  193. Reading input from stdin:
  194. The '^add' command can read paths from stdin. To do this, pass a single dash
  195. "-".
  196. Example: cm ^add -
  197. Paths will be read until an empty line is entered.
  198. This allows you to use pipe to specify which files to add.
  199. Example:
  200. dir /S /B *.c | cm ^add -
  201. (In Windows, adds all .c files in the workspace.)
  202. Examples:
  203. cm ^add file1.txt file2.txt
  204. (Adds 'file1.txt' and 'file2.txt' items.)
  205. cm ^add c:\workspace\file.txt
  206. (Adds 'file.txt' item in path 'c:\workspace'.)
  207. cm ^add -^R c:\workspace\src
  208. (Recursively adds 'src'.)
  209. cm ^add -^R *
  210. (Recursively adds all the contents of the current directory.)
  211. cm ^add -^R * --^filetypes=filetypes.conf
  212. (Recursively adds all the contents of the current directory, using
  213. 'filetypes.conf' to assign a type to each file based on its extension,
  214. instead of checking its content.)
  215. cm ^add --^coparent c:\workspace\dir\file.txt
  216. (Adds 'file.txt' to source control, and performs a checkout of 'dir'.)
  217. cm ^add -^R * --^format="ADD {0}" --^errorformat="ERR {0}"
  218. (Recursively adds all the contents of the current directory, printing
  219. '^ADD <item>' for successfully added files, and '^ERR <item>' for items that
  220. could not be added.)
  221. == CMD_USAGE_ADDIGNOREPATTERN ==
  222. Usage:
  223. cm ^addignorepattern <pattern>[ ...]
  224. [--^workspace=<wkpath> | --^allworkspaces] [--^remove]
  225. == CMD_DESCRIPTION_ADMIN ==
  226. Executes administrative commands on the server.
  227. == CMD_USAGE_ADMIN ==
  228. Usage:
  229. cm ^admin <command> [options]
  230. Available commands:
  231. ^readonly
  232. To get more information about each command run:
  233. cm ^admin <command> --^usage
  234. cm ^admin <command> --^help
  235. == CMD_HELP_ADMIN ==
  236. Remarks:
  237. Only the server administrator can execute administrative commands.
  238. Examples:
  239. cm ^admin ^readonly ^enter
  240. cm ^admin ^readonly ^status
  241. == CMD_DESCRIPTION_ADMIN_READONLY ==
  242. Enables/disables the server readonly mode.
  243. == CMD_USAGE_ADMIN_READONLY ==
  244. Usage:
  245. cm ^admin ^readonly (^enter | ^leave | ^status) [<server>]
  246. Actions:
  247. ^enter The server enters read-only mode. Write operations will be rejected.
  248. ^leave The server leaves read-only mode.
  249. ^status Shows the server read-only mode status.
  250. Options:
  251. server Executes the command in the specified server (server:port). (Use
  252. 'cm ^help ^objectspec' to learn more about server specs.)
  253. If no server is specified, the command works with the server of the
  254. current workspace.
  255. If the current path is not in a workspace, the command works with
  256. the default server defined in the client.conf config file.
  257. == CMD_HELP_ADMIN_READONLY ==
  258. Remarks:
  259. Only the server administrator can enter the server readonly mode.
  260. Examples:
  261. cm ^admin ^readonly ^enter diana:8086
  262. cm ^admin ^readonly ^leave
  263. == CMD_DESCRIPTION_ANNOTATE ==
  264. Shows the changeset where each line of a file was last modified and its author.
  265. == CMD_USAGE_ANNOTATE ==
  266. Usage:
  267. cm ^annotate | ^blame <spec>[ ...]
  268. [--^format=<str_format>]
  269. [--^comparisonmethod=(^ignoreeol | ^ignorewhitespaces
  270. | ^ignoreeolandwhitespaces | ^recognizeall)]
  271. [--^dateformat=<str_date_format>]
  272. [--^encoding=<name>]
  273. [--^stats]
  274. [--^repository=<repspec>]
  275. spec The spec of the file to annotate.
  276. (Use 'cm ^help ^objectspec' to learn more about specs.)
  277. Use double quotes (" ") to specify paths containing spaces.
  278. Options:
  279. --^format Retrieves the output message in a specific format. See
  280. Remarks for more info.
  281. --^comparisonmethod Sets the specified comparison method. See Remarks for more info.
  282. --^dateformat Sets the output format to print dates.
  283. --^encoding Specifies the output encoding, i.e.: utf-8.
  284. See the MSDN documentation at
  285. http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx
  286. to get the table of supported encodings and its format,
  287. (at the end of the page, in the "Name" column).
  288. --^stats Shows statistics information.
  289. --^repository Specifies a repository spec used to calculate
  290. the annotations. By default, this command uses the
  291. repository where the loaded revision repository in the
  292. workspace is stored. (Use 'cm ^help ^objectspec' to learn
  293. more about repspecs.)
  294. == CMD_HELP_ANNOTATE ==
  295. Remarks:
  296. Binary files can't be annotated.
  297. Comparison methods (--^comparisonmethod option):
  298. ^ignoreeol Ignores the end of line differences.
  299. ^ignorewhitespaces Ignores the whitespace differences.
  300. ^ignoreeolandwhitespaces Ignores the end of line and whitespace differences.
  301. ^recognizeall Detects the end of line and whitespace differences.
  302. Output format parameters (--^format option):
  303. This command accepts a format string to show the output.
  304. The output parameters of this command are the following:
  305. {^owner} User who changed the line the last time.
  306. {^rev} Source revision specification of the line.
  307. {^content} Line content.
  308. {^date} Date when the line was checked in.
  309. {^comment} Comment of the source revision of the line.
  310. {^changeset} Changeset of the source revision of the line.
  311. {^line} Line number of the file.
  312. {^id} Item id.
  313. {^parentid} Parent id of the item.
  314. {^rep} Repository of the item.
  315. {^branch} Branch of the source revision of the line.
  316. {^ismergerev} Whether the revision of the line was created in a merge.
  317. --^dateformat:
  318. To specify the output format in which dates will be printed.
  319. See the supported formats specified at:
  320. https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings
  321. --^repository:
  322. To retrieve data from a remote repository. Useful for distributed
  323. scenarios.
  324. Examples:
  325. cm ^blame c:\workspace\src --^comparisonmethod=^ignoreeolandwhitespaces --^encoding=utf-8
  326. cm ^annotate c:\workspace\file.txt --^comparisonmethod=^ignoreeol
  327. cm ^annotate c:\workspace\file.txt --^format="{^owner} {^date, 10} {^content}"
  328. (Writes the owner field, then a blank, then the date field (aligned to
  329. right), then a blank, and the content.)
  330. cm ^blame c:\workspace\file.txt --^format="{^owner, -7} {^comment} {^date}" \
  331. --^dateformat=yyyyMMdd
  332. (Writes the owner field in 7 spaces (aligned to the left) followed by
  333. a blank, then the comment, followed by another blank, and ending with the
  334. formatted date (for example, 20170329).)
  335. cm ^annotate c:\workspace\file.txt --^repository=centralRep@myserver:8084
  336. cm ^blame ^serverpath:/src/client/checkin/Checkin.cs#^cs:73666
  337. (Annotates the file starting in changeset 73666 using a server path.)
  338. == CMD_DESCRIPTION_APPLY_LOCAL ==
  339. Checks for local changes (locally moved, locally deleted, and locally changed)
  340. and applies them, so that Plastic SCM starts tracking those changes.
  341. == CMD_USAGE_APPLY_LOCAL ==
  342. Usage:
  343. cm ^applylocal | ^al [--^dependencies] [<item_path>[ ...]]
  344. [--^machinereadable [--^startlineseparator=<sep>]
  345. [--^endlineseparator=<sep>] [--^fieldseparator=<sep>]]
  346. Options:
  347. --^dependencies Adds local change dependencies into the items to
  348. apply.
  349. item_path Items to be applied. Use a whitespace to separate
  350. paths. Use double quotes (" ") to specify paths
  351. containing spaces.
  352. --^machinereadable Outputs the result in an easy-to-parse format.
  353. --^startlineseparator Used with the '--^machinereadable' flag, specifies how
  354. the lines should start.
  355. --^endlineseparator Used with the '--^machinereadable' flag, specifies how
  356. the lines should end.
  357. --^fieldseparator Used with the '--^machinereadable' flag, specifies how
  358. the fields should be separated.
  359. == CMD_HELP_APPLY_LOCAL ==
  360. Remarks:
  361. - If --^dependencies and <item_path> are not specified, the operation involves
  362. all the local changes in the workspace.
  363. - It is always applied recursively from the given path.
  364. Examples:
  365. cm ^applylocal foo.c bar.c
  366. cm ^applylocal .
  367. (Applies all local changes in the current directory.)
  368. cm ^applylocal
  369. (Applies all local changes in the workspace.)
  370. cm ^applylocal --^machinereadable
  371. (Applies all local changes in the workspace, and prints the result in a
  372. simplified, easier-to-parse format.)
  373. cm ^applylocal --^machinereadable --^startlineseparator=">" \
  374. --^endlineseparator="<" --^fieldseparator=","
  375. (Applies all local changes in the workspace, and prints the result in a
  376. simplified, easier-to-parse format, starting and ending the lines and
  377. separating the fields with the specified strings.)
  378. == CMD_DESCRIPTION_ARCHIVE ==
  379. Archives data in external storage.
  380. == CMD_USAGE_ARCHIVE ==
  381. Usage:
  382. cm ^archive | ^arch <revspec>[ ...] [-^c=<str_comment>]
  383. [--^file=<base_file>]
  384. (Extracts data from the repository and stores it on external storage.)
  385. cm ^archive | ^arch <revspec>[ ...] --^restore
  386. (Restores previously archived revisions back into the repository.)
  387. revspec One or more revision specs. (Use 'cm ^help ^objectspec'
  388. to learn more about revspecs.)
  389. --^restore Restores previously archived data from generated archive
  390. files. The external storage location and the
  391. externaldata.conf file must be available at the moment
  392. of the revision restoration. See Remarks for more
  393. information.
  394. Options:
  395. -^c Sets a comment in the archive storage files to create.
  396. --^file Name prefix and (optional) path for the new archive
  397. data files.
  398. == CMD_HELP_ARCHIVE ==
  399. Remarks:
  400. This command extracts data from the repository database and store it on
  401. external storage, saving database space.
  402. The command can also restore (--^restore) previously archived revisions back
  403. into the repository database.
  404. Use 'cm ^help ^objectspec' to learn how to specify a revspec.
  405. The user running this command must be the Plastic SCM server administrator
  406. (repository server owner) to be allowed to complete the operation.
  407. Every data segment from the specified revisions will be stored in a
  408. different file, with a name starting with the value defined by the --^file
  409. argument. This argument can contain either a full path value including a
  410. prefix for future archive files or just this prefix value.
  411. Once archived, the data from the specified revisions will be accessible in
  412. two ways:
  413. 1. From the client: The client will detect if the data was archived and it
  414. will prompt the user to enter the location of the files.
  415. Users can configure the external data location by creating a file named
  416. externaldata.conf (at the standard configuration files locations, using
  417. the same rules that apply for the client.conf file) containing the paths
  418. where archived data have been located.
  419. 2. From the server: This way users won't have to know whether the data was
  420. archived or not, since requests will be transparently resolved by the
  421. server. To do so, the administrator will create a file called
  422. externaldata.conf in the server directory and will fill it with the
  423. paths where the archived volumes are.
  424. To unarchive (restore) a revision (or set of revisions), the archived
  425. files must be accessible from the client. Hence, it is not possible to
  426. unarchive data being resolved by the server (method 2) because the client
  427. will not be able to identify it as archived.
  428. If method 2 is used, to unarchive successfully, the administrator will have
  429. to edit the externaldata.conf server file first to remove access to the
  430. archived files which have to be unarchived.
  431. Archive example:
  432. 1) Archive one revision:
  433. cm ^archive Assets/RoofTextures/Textures/Wooden_Roof_05.png --^file=/Users/ruben/archive/battle
  434. 2) See the archived revision in the specified output path:
  435. ^ls -^al /Users/ruben/archive/battle*
  436. -rw-r--r-- 1 ruben staff 2220039 Nov 9 10:52 /Users/ruben/archive/battle-100280-167
  437. Unarchive (restore) example:
  438. 1) Add the output archive folder to the externaldata.conf file:
  439. ^vi /Users/ruben/.plastic4/externaldata.conf
  440. /Users/ruben/archive
  441. 2) Unarchive the revision:
  442. cm ^archive Assets/RoofTextures/Textures/Wooden_Roof_05.png --^restore
  443. Set the PLASTICEDITOR environment variable to specify an editor for
  444. entering comments. If the PLASTICEDITOR environment variable is set, and
  445. the comment is empty, the editor will be automatically launched to allow
  446. you to specify the comment.
  447. Reading input from stdin:
  448. The '^archive' command can read paths from stdin. To do this, pass a single
  449. dash "-".
  450. Example: cm ^archive -
  451. Paths will be read until an empty line is entered.
  452. This allows you to use pipe to specify which files to archive.
  453. Example:
  454. dir /S /B *.c | cm ^archive -
  455. (In Windows, archives all .c files in the workspace.)
  456. Examples:
  457. cm ^archive bigfile.zip#^br:/^main
  458. (Archives the last revision of 'bigfile.zip' in branch 'main'.)
  459. cm ^archive bigfile.zip#^br:/^main --^restore
  460. (Restores the archived revision.)
  461. cm ^archive ^rev:myfile.pdf#^cs:2 -^c="big pdf file" --^file=c:\arch_files\arch
  462. (Archives the revision with changeset 2 of myfile.pdf in 'c:\archived_files'
  463. folder. The archived file name will start with 'arch' (for example, arch_11_56).)
  464. cm ^find "^revs ^where ^size > 26214400" --^format="{^item}#{^branch}" \
  465. --^nototal | cm ^archive -^c="volume00" --^file="volume00" -
  466. (Archives all the files bigger than 25Mb on files starting with name
  467. 'volume00'.)
  468. == CMD_DESCRIPTION_ATTRIBUTE ==
  469. Allows the user to manage attributes.
  470. == CMD_USAGE_ATTRIBUTE ==
  471. Usage:
  472. cm ^attribute | ^att <command> [options]
  473. Commands:
  474. ^create | ^mk
  475. ^delete | ^rm
  476. ^set
  477. ^unset
  478. ^rename
  479. ^edit
  480. To get more information about each command run:
  481. cm ^attribute <command> --^usage
  482. cm ^attribute <command> --^help
  483. == CMD_HELP_ATTRIBUTE ==
  484. Examples:
  485. cm ^attribute ^create status
  486. cm ^attribute ^set ^att:status ^br:/main/SCM105 open
  487. cm ^attribute ^unset ^att:status ^br:/main/SCM105
  488. cm ^attribute ^delete ^att:status
  489. cm ^attribute ^rename ^att:status "buildStatus"
  490. cm ^attribute ^edit ^att:status "Status of the task in the CI pipeline"
  491. == CMD_DESCRIPTION_CHANGELIST ==
  492. Groups pending changes in changelists.
  493. == CMD_USAGE_CHANGELIST ==
  494. Usage:
  495. a) Management of changelists objects:
  496. cm ^changelist | ^clist [--^symlink]
  497. (Displays all changelists.)
  498. cm ^changelist | ^clist ^create <clist_name>
  499. [<clist_desc>] [--^persistent | --^notpersistent] [--^symlink]
  500. (Creates a changelist.)
  501. cm ^changelist | ^clist ^delete <clist_name> [--^symlink]
  502. (Deletes the selected changelist. If this changelist contains pending
  503. changes, then these will be moved to the ^default changelist.)
  504. cm ^changelist | ^clist ^edit <clist_name> [<action_name> <action_value>]
  505. [--^persistent | --^notpersistent] [--^symlink]
  506. (Edits the selected changelist.)
  507. b) Management of contents of a given changelist:
  508. cm ^changelist | ^clist <clist_name> (^add | ^rm) <path_name>[ ...]
  509. [--^symlink]
  510. (Edits the selected changelist by adding ('^add') or removing ('^rm') the
  511. change(s) that match with the given path_name(s). Use a whitespace to
  512. separate path_names. Use double quotes (" ") to specify paths containing
  513. spaces. The status of the paths must be '^Added' or '^Checked-out'.)
  514. Options:
  515. clist_name The name of the changelist. A path to a file containing
  516. the name can be used instead. More info at --^namefile.
  517. clist_desc The description of the changelist. A path to a file
  518. containing the description can be used instead. More
  519. info at --^descriptionfile.
  520. action_name Choose between '^rename' or '^description' to edit the
  521. changelist.
  522. action_value Applies the new name or new description when editing
  523. the changelist.
  524. --^persistent The changelist will remain in the workspace even if its
  525. contents are checked-in or reverted.
  526. --^notpersistent (Default) The changelist will not remain in the
  527. workspace even if its contents are checked-in or
  528. reverted.
  529. --^symlink Applies the operation to the symlink and not to the
  530. target.
  531. --^namefile A valid path to a file containing the name of the
  532. changelist. Bear in mind the file must exist and its
  533. content cannot be neither empty nor multiline.
  534. --^newnamefile A valid path to a file containing the new name of the
  535. changelist when renaming. Bear in mind the file must exist
  536. and its content cannot be neither empty nor multiline.
  537. --^descriptionfile A valid path to a file containing the description for the
  538. changelist. Bear in mind the file must exist.
  539. == CMD_HELP_CHANGELIST ==
  540. Remarks:
  541. The '^changelist' command handles both the workspace pending changelists and
  542. the changes contained in a changelist.
  543. Examples:
  544. cm ^changelist
  545. (Shows the current workspace changelists.)
  546. cm ^changelist ^create config_changes "dotConf files" --^persistent
  547. (Creates a new changelist named 'config_changes' and description 'dotConf
  548. files' which will remain persistent in the current workspace once the
  549. pending changelist is either checked-in or reverted.)
  550. cm ^changelist ^create --^namefile="name.txt" --^descriptionfile="desc.txt"
  551. (Creates a new changelist which name and description are both taken from files.)
  552. cm ^changelist ^edit config_changes ^rename config_files --^notpersistent
  553. (Edits the changelist named 'config_changes' and renames it to
  554. 'config_files'. Also, it turns the changelist into "not persistent".)
  555. cm ^changelist ^edit config_changes --^notpersistent
  556. (Edits the changelist named 'config_changes' by turning it into "not persistent".)
  557. cm ^changelist ^delete config_files
  558. (Removes the pending changelist 'config_files' from the current workspace.)
  559. cm ^changelist ^delete --namefile="name.txt"
  560. (Removes the changelist identified by the content of 'name.txt' file from the current
  561. workspace.)
  562. cm ^changelist config_files ^add foo.conf
  563. (Adds the file 'foo.conf' to the 'config_files' changelist.)
  564. cm ^changelist config_files ^rm foo.conf readme.txt
  565. (Removes the files 'foo.conf' and 'readme.txt' from the 'config_files'
  566. changelist and moves the files to the system default changelist.)
  567. cm ^changelist ^edit --^namefile="name.txt" ^description --^descriptionfile="desc.txt"
  568. (Edits the changelist identified by the content of 'name.txt' file, changing its
  569. description to the text content of the 'desc.txt' file.)
  570. cm ^changelist ^edit --^namefile="name.txt" ^rename --^newnamefile="newname.txt"
  571. (Edits the changelist identified by the content of 'name.txt' file, renaming it to
  572. the text content of the 'newname.txt' file.)
  573. == CMD_DESCRIPTION_CHANGESET ==
  574. Executes advanced operations on changesets.
  575. == CMD_USAGE_CHANGESET ==
  576. Usage:
  577. cm ^changeset <command> [options]
  578. Commands:
  579. ^move | ^mv
  580. ^delete | ^rm
  581. ^editcomment | ^edit
  582. To get more information about each command run:
  583. cm ^changeset <command> --^usage
  584. cm ^changeset <command> --^help
  585. == CMD_HELP_CHANGESET ==
  586. Examples:
  587. cm ^changeset ^move ^cs:15@myrepo ^br:/main/scm005@myrepo
  588. cm ^changeset ^delete ^cs:2b55f8aa-0b29-410f-b99c-60e573a309ca@devData
  589. == CMD_DESCRIPTION_CHANGESET_EDIT_COMMENT ==
  590. Modifies the comment of a changeset.
  591. == CMD_USAGE_CHANGESET_EDIT_COMMENT ==
  592. Usage:
  593. cm ^changeset ^editcomment | ^edit <csetspec> <new_comment>
  594. Options:
  595. csetspec The target changeset whose comment will be edited.
  596. (Use 'cm ^help ^objectspec' to learn more about changeset
  597. specs.)
  598. new_comment The new comment that will be added to the targeted
  599. changeset.
  600. == CMD_HELP_CHANGESET_EDIT_COMMENT ==
  601. Remarks:
  602. - The targeted changeset spec must be valid.
  603. Examples:
  604. cm ^changeset ^editcomment ^cs:15@myrepo "I forgot to add the checkin details"
  605. cm ^changeset ^edit ^cs:cb11ecdb-1aa9-4f11-8698-dcab14e5885a \
  606. "This comment text will replace the previous one."
  607. cm ^changeset ^edit "89095131-895d-4173-9440-ff9ef9b2538d@project@cloud" \
  608. "Changing my comment"
  609. == CMD_DESCRIPTION_CHANGESET_MOVE ==
  610. Moves a changeset and all its descendants to a different branch.
  611. == CMD_USAGE_CHANGESET_MOVE ==
  612. Usage:
  613. cm ^changeset ^move | ^mv <csetspec> <branchspec>
  614. Options:
  615. csetspec First changeset to be moved to a different branch. All
  616. descendant changesets in the same branch will be
  617. targeted by the command as well.
  618. (Use 'cm ^help ^objectspec' to learn more about changeset
  619. specs.)
  620. branchspec The target branch where the targeted changesets are
  621. stored. It needs to be empty or non-existing; if the
  622. destination branch doesn't exist, it will be created by
  623. the command.
  624. (Use 'cm ^help ^objectspec' to learn more about branch
  625. specs.)
  626. == CMD_HELP_CHANGESET_MOVE ==
  627. Remarks:
  628. - The targeted changeset spec must be valid.
  629. - The destination branch must be either empty or non-existing.
  630. - If the destination branch doesn't exist, it will created.
  631. - Merge links will be kept unchanged since branches don't affect them.
  632. Examples:
  633. cm ^changeset ^move ^cs:15@myrepo ^br:/main/scm005@myrepo
  634. cm ^changeset ^move ^cs:cb11ecdb-1aa9-4f11-8698-dcab14e5885a ^br:/hotfix/TL-352
  635. == CMD_DESCRIPTION_CHANGESET_DELETE ==
  636. Deletes a changeset from the repository.
  637. == CMD_USAGE_CHANGESET_DELETE ==
  638. Usage:
  639. cm ^changeset ^delete | ^rm <csetspec>
  640. Options:
  641. csetspec The target changeset to be removed. It must fulfill
  642. some specific conditions. See Remarks for more info.
  643. (Use 'cm ^help ^objectspec' to learn more about changeset
  644. specs.)
  645. == CMD_HELP_CHANGESET_DELETE ==
  646. Remarks:
  647. - The target changeset must be the last in its branch.
  648. - The target changeset cannot be the parent of any other changeset.
  649. - The target changeset cannot be neither the source of a merge link nor
  650. part of an interval merge as source.
  651. - No label must be applied to the target changeset.
  652. - The target changeset must not be the root changeset ('^cs:0').
  653. Examples:
  654. cm ^changeset ^rm ^cs:4525@myrepo@myserver
  655. cm ^changeset ^delete ^cs:cb11ecdb-1aa9-4f11-8698-dcab14e5885a
  656. == CMD_DESCRIPTION_CHANGEUSERPASSWORD ==
  657. Changes the user's password (UP).
  658. == CMD_USAGE_CHANGEUSERPASSWORD ==
  659. Usage:
  660. cm ^changepassword | ^passwd
  661. == CMD_HELP_CHANGEUSERPASSWORD ==
  662. Remarks:
  663. This command is only available when the security configuration is UP
  664. (user/password).
  665. See the Administrator Guide for more information:
  666. https://www.plasticscm.com/download/help/adminguide
  667. The old and new passwords are required.
  668. Examples:
  669. cm ^passwd
  670. == CMD_DESCRIPTION_CHECKCONNECTION ==
  671. Checks the connection to the server.
  672. == CMD_USAGE_CHECKCONNECTION ==
  673. Usage:
  674. cm ^checkconnection | ^cc
  675. == CMD_HELP_CHECKCONNECTION ==
  676. Remarks:
  677. - This command returns a message indicating whether there is a valid
  678. connection to the configured Plastic SCM server.
  679. - The command checks checks the version compatibility with the server.
  680. - The command also checks whether the configured user is valid or not.
  681. == CMD_DESCRIPTION_CHECKDB ==
  682. Checks the repositories integrity.
  683. == CMD_USAGE_CHECKDB ==
  684. Usage:
  685. cm ^checkdatabase | ^chkdb [<repserverspec> | <repspec>]
  686. Options:
  687. repserverspec Repositories server.
  688. repspec Repository.
  689. (Use 'cm ^help ^objectspec' to learn more about repserver and rep specs.)
  690. == CMD_HELP_CHECKDB ==
  691. Remarks:
  692. - If neither repserverspec nor repspec are specified, the check will be
  693. performed in the server specified in the client.conf file.
  694. Examples:
  695. cm ^checkdatabase ^repserver:localhost:8084
  696. cm ^chkdb ^rep:default@localhost:8084
  697. == CMD_DESCRIPTION_CHECKIN ==
  698. Stores changes in the repository.
  699. == CMD_USAGE_CHECKIN ==
  700. Usage:
  701. cm ^checkin | ^ci [<item_path>[ ...]]
  702. [-^c=<str_comment> | -^commentsfile=<comments_file>]
  703. [--^all|-^a] [--^applychanged] [--^private] [--^update] [--^symlink]
  704. [--^noshowchangeset]
  705. [--^machinereadable [--^startlineseparator=<sep>]
  706. [--^endlineseparator=<sep>] [--^fieldseparator=<sep>]]
  707. Options:
  708. item_path Items to be checked-in. Use double quotes (" ") to
  709. specify paths containing spaces. Use a whitespace to
  710. separate item paths.
  711. Use . to apply checkin to current directory.
  712. -^c Applies the specified comment to the changeset created
  713. in the checkin operation.
  714. -^commentsfile Applies the comment in the specified file to the
  715. changeset created in the checkin operation.
  716. --^all | -^a The items changed, moved and deleted locally on the
  717. given paths are also included.
  718. --^applychanged Applies the checkin operation to the changed items
  719. detected in the workspace along with the checked out
  720. items.
  721. --^private Private items detected in the workspace are also
  722. included.
  723. --^update Processes the update-merge automatically if it
  724. eventually happens.
  725. --^symlink Applies the checkin operation to the symlink and not
  726. to the target.
  727. --^noshowchangeset Doesn't print the result changeset.
  728. --^machinereadable Outputs the result in an easy-to-parse format.
  729. --^startlineseparator Used with the '--^machinereadable' flag, specifies how
  730. the lines should start.
  731. --^endlineseparator Used with the '--^machinereadable' flag, specifies how
  732. the lines should end.
  733. --^fieldseparator Used with the '--^machinereadable' flag, specifies how
  734. the fields should be separated.
  735. == CMD_HELP_CHECKIN ==
  736. Remarks:
  737. - If <item_path> is not specified, the checkin involves all the
  738. pending changes in the workspace.
  739. - The checkin operation is always applied recursively from the given path.
  740. - To checkin an item:
  741. - The item must be under source code control.
  742. - If the item is private (not under source code control), the --^private
  743. flag is necessary in order to checkin it.
  744. - The item must be checked out.
  745. - If the item is changed but not checked out, the --^applychanged flag
  746. is not necessary unless <item_path> is a directory or it contains
  747. wildcards ('*').
  748. Revision content should be different from previous revision in order to be
  749. checked in.
  750. Set the PLASTICEDITOR environment variable to specify an editor for
  751. entering comments. If the PLASTICEDITOR environment variable is set, and
  752. the comment is empty, the editor will be automatically launched to allow
  753. you to specify the comment.
  754. Reading input from stdin:
  755. The '^checkin' command can read paths from stdin. To do this, pass a single
  756. dash "-".
  757. Example: cm ^checkin -
  758. Paths will be read until an empty line is entered.
  759. This allows you to use pipe to specify which files to checkin.
  760. Example:
  761. dir /S /B *.c | cm ^checkin --^all -
  762. (In Windows, checkins all .c files in the workspace.)
  763. Examples:
  764. cm ^checkin file1.txt file2.txt
  765. (Checkins the 'file1.txt' and 'file2.txt' checked-out files.)
  766. cm ^checkin . -^commentsfile=mycomment.txt
  767. (Checkins the current directory and sets the comment in the
  768. 'mycomment.txt' file.)
  769. cm ^checkin link --^symlink
  770. (Checkins the symlink file and not the target.)
  771. cm ^ci file1.txt -^c="my comment"
  772. (Checkins 'file1.txt' and includes a comment.)
  773. cm ^status --^short --^compact --^changelist=pending_to_review | cm ^checkin -
  774. (Lists the paths in the changelist named 'pending_to_review' and redirects
  775. this list to the input of the checkin command.)
  776. cm ^ci . --^machinereadable
  777. (Checkins the current directory, and prints the result in a simplified,
  778. easier-to-parse format.)
  779. cm ^ci . --^machinereadable --^startlineseparator=">" --^endlineseparator="<" --^fieldseparator=","
  780. (Checkins the current directory, and prints the result in a simplified,
  781. easier-to-parse format, starting and ending the lines, and
  782. separating the fields with the specified strings.)
  783. == CMD_DESCRIPTION_CHECKOUT ==
  784. Marks files as ready to modify.
  785. == CMD_USAGE_CHECKOUT ==
  786. Usage:
  787. cm ^checkout | ^co [<item_path>[ ...]] [-^R | -^r | --^recursive]
  788. [--^format=<str_format>]
  789. [--^errorformat=<str_format>] [--^resultformat=<str_format>]
  790. [--^silent] [--^symlink] [--^ignorefailed]
  791. [--^machinereadable [--^startlineseparator=<sep>]
  792. [--^endlineseparator=<sep>] [--^fieldseparator=<sep>]]
  793. Options:
  794. item_path Items to be checked-out. Use double quotes (" ") to
  795. specify paths containing spaces. Use a whitespace to
  796. separate item paths.
  797. Use . to apply checkout to current directory.
  798. -^R Checks out files recursively.
  799. --^format Retrieves the output progress message in a specific
  800. format. Check the examples for more information.
  801. --^resultformat Retrieves the output result message in a specific
  802. format. Check the examples for more information.
  803. --^silent Does not show any output at all.
  804. --^symlink Applies the checkout operation to the symlink and not
  805. to the target.
  806. --^ignorefailed If an item cannot be locked (the exclusive checkout
  807. cannot be performed), the checkout operation will
  808. continue without it.
  809. --^machinereadable Outputs the result in an easy-to-parse format.
  810. --^startlineseparator Used with the '--^machinereadable' flag, specifies how
  811. the lines should start.
  812. --^endlineseparator Used with the '--^machinereadable' flag, specifies how
  813. the lines should end.
  814. --^fieldseparator Used with the '--^machinereadable' flag, specifies how
  815. the fields should be separated.
  816. == CMD_HELP_CHECKOUT ==
  817. Remarks:
  818. To checkout an item:
  819. - The item must be under source code control.
  820. - The item must be checked-in.
  821. If locks are configured on the server (lock.conf exists), then each time
  822. a checkout on a path happens, Plastic checks if it meets any of the rules
  823. and if so, the path will be in exclusive checkout (locked) so that none can
  824. simultaneously checkout.
  825. You can get all the locks in the server by using 'cm ^lock ^list'.
  826. See the Administrator Guide for more information:
  827. https://www.plasticscm.com/download/help/adminguide
  828. The format string replaces the placeholder '{0}' with the path of the item
  829. being checked out. Check the examples to see how to use it.
  830. Reading input from stdin:
  831. The '^checkout' command can read paths from stdin. To do this, pass a single
  832. dash "-".
  833. Example: cm ^checkout -
  834. Paths will be read until an empty line is entered.
  835. This allows you to use pipe to specify which files to checkout.
  836. Example:
  837. dir /S /B *.c | cm ^checkout -
  838. (In Windows, checkouts all .c files in the workspace.)
  839. Examples:
  840. cm ^checkout file1.txt file2.txt
  841. (Checkouts 'file1.txt' and 'file2.txt' files.)
  842. cm ^co *.txt
  843. (Checkouts all txt files.)
  844. cm ^checkout .
  845. (Checkouts current directory.)
  846. cm ^checkout -^R c:\workspace\src
  847. (Recursively checkouts 'src' folder.)
  848. cm ^co file.txt --^format="Checking out item {0}"
  849. --^resultformat="Item {0} checked out"
  850. (Checkouts 'file.txt' using the specified formatting strings
  851. to show the progress and the result of the operation.)
  852. cm ^checkout link --^symlink
  853. (Checkouts the symlink file and not the target.)
  854. cm ^checkout . -^R --^ignorefailed
  855. (Recursively checkouts the current folder, ignoring those files that can
  856. not be checked out.)
  857. cm ^co . --^machinereadable --^startlineseparator=">"
  858. (Checkouts the current directory, and prints the result in a simplified,
  859. easier-to-parse format, starting the lines with the specified strings.)
  860. == CMD_DESCRIPTION_CHECKSELECTORSYNTAX ==
  861. Checks the syntax of a selector.
  862. == CMD_USAGE_CHECKSELECTORSYNTAX ==
  863. Usage:
  864. cm ^checkselectorsyntax | ^css --^file=<selector_file>
  865. (Checks the selector file syntax.)
  866. ^cat <selector_file> | cm ^checkselectorsyntax | ^css -
  867. (Unix. Checks selector file from standard input.)
  868. ^type <selector_file> | cm ^checkselectorsyntax | ^css -
  869. (Windows. Checks selector file from standard input.)
  870. --^file The file to read a selector from.
  871. == CMD_HELP_CHECKSELECTORSYNTAX ==
  872. Remarks:
  873. This command reads a selector on either a file or standard input, and
  874. checks it for valid syntax. If the syntax check fails, the reason is
  875. printed on standard output.
  876. Examples:
  877. cm ^checkselectorsyntax --^file=myselector.txt
  878. (Checks the syntax of 'myselector.txt' file.)
  879. ^cat myselector.txt | cm ^checkselectorsyntax
  880. (Checks the syntax of 'myselector.txt' from standard input.)
  881. == CMD_DESCRIPTION_CHGREVTYPE ==
  882. Changes an item revision type (binary or text).
  883. == CMD_USAGE_CHGREVTYPE ==
  884. Usage:
  885. cm ^changerevisiontype | ^chgrevtype | ^crt <item_path>[ ...] --^type=(^bin | ^txt)
  886. item_path Items to change revision type. Use double quotes (" ")
  887. to specify paths containing spaces. Use a whitespace to
  888. separate item paths.
  889. --^type Target revisions type. Choose '^bin' or '^txt'.
  890. == CMD_HELP_CHGREVTYPE ==
  891. Remarks:
  892. This command can only be applied to files, not directories.
  893. The specified type must be a system supported one: '^bin' or '^txt' (binary
  894. or text).
  895. Examples:
  896. cm ^changerevisiontype c:\workspace\file.txt --^type=^txt
  897. (Changes 'file.txt' revision type to text.)
  898. cm ^chgrevtype comp.zip "image file.jpg" --^type=^bin
  899. (Changes 'comp.zip' and "image file.jpg" revision type to binary.)
  900. cm ^crt *.* --^type=^txt
  901. (Changes revision type of all files to text.)
  902. == CMD_DESCRIPTION_TRIGGER_EDIT ==
  903. Edits a trigger.
  904. == CMD_USAGE_TRIGGER_EDIT ==
  905. Usage:
  906. cm ^trigger | ^tr ^edit <subtype_type> <position_number>
  907. [--^position=<new_position>]
  908. [--^name=<new_name>] [--^script=<script_path>]
  909. [--^filter=<str_filter>] [--^server=<repserverspec>]
  910. subtype_type Trigger execution and trigger operation.
  911. (Use 'cm ^showtriggertypes' to see a list of trigger
  912. types.)
  913. position_number Position occupied by the trigger to be modified.
  914. Options:
  915. --^position New position of the specified trigger.
  916. This position must not be in use by another
  917. trigger of the same type.
  918. --^name New name of the specified trigger.
  919. --^script New execution path of the specified trigger script.
  920. If the script starts with "^webtrigger ", it will be
  921. considered as a web trigger. See Remarks for more
  922. further details.
  923. --^filter Checks only items that match the specified filter.
  924. --^server Modifies the trigger on the specified server.
  925. If no server is specified, executes the command on the
  926. one configured on the client.
  927. (Use 'cm ^help ^objectspec' to learn more about server
  928. specs.)
  929. == CMD_HELP_TRIGGER_EDIT ==
  930. Remarks:
  931. Web triggers: A web trigger is created by typing "^webtrigger <target-uri>"
  932. as the trigger command. In this case, the trigger will execute a POST query
  933. against the specified URI, where the request body contains a JSON
  934. dictionary with the trigger environment variables, and a fixed INPUT key
  935. pointing to an array of strings.
  936. Examples:
  937. cm ^trigger ^edit ^after-setselector 6 --^name="Backup2 manager" --^script="/new/path/al/script"
  938. cm ^tr ^edit ^before-mklabel 7 --^position=4 --^server=myserver:8084
  939. cm ^trigger ^edit ^after-add 2 --^script="^webtrigger http://myserver.org/api"
  940. == CMD_DESCRIPTION_CODEREVIEW ==
  941. Creates, edits, or deletes code reviews.
  942. == CMD_USAGE_CODEREVIEW ==
  943. Usage:
  944. cm ^codereview <spec> <title> [--^status=<status_name>]
  945. [--^assignee=<user_name>] [--^format=<str_format>]
  946. [--^repository=<rep_spec>]
  947. (Creates a code review.)
  948. cm ^codereview -^e <id> [--^status=<status_name>] [--^assignee=<user_name>]
  949. [--^repository=<rep_spec>]
  950. (Edits a code review.)
  951. cm ^codereview -^d <id> [ ...] [--^repository=<rep_spec>]
  952. (Deletes one or more code reviews.)
  953. spec It can be either a changeset spec or a branch spec. It will be
  954. the target of the new code review. (Use 'cm ^help ^objectspec'
  955. to learn more about changeset or branch specs.)
  956. title A text string to be used as title of the new code review.
  957. id The code review identification number. A GUID can be used as
  958. well.
  959. Options:
  960. -^e Edits the parameters of an existing code review.
  961. -^d Deletes one or more existing code reviews. Use a
  962. whitespace to separate the code reviews IDs.
  963. --^status Sets the new status of a code review. See Remarks for
  964. additional information.
  965. --^assignee Sets the new assignee of a code review.
  966. --^format Retrieves the output message in a specific format. See
  967. Remarks for additional information.
  968. --^repository Sets the repository to be used as default. (Use
  969. 'cm ^help ^objectspec' to learn more about repository specs.)
  970. == CMD_HELP_CODEREVIEW ==
  971. Remarks:
  972. This command allows users to manage code reviews: create, edit, and delete
  973. code reviews for changesets or branches.
  974. To create a new code review, a changeset/branch spec and a title are
  975. required. The initial status and assignee can be set, too. An ID (or GUID
  976. if requested) will be returned as a result.
  977. To edit or delete an existing code review, the target code review ID
  978. (or GUID) is required. No messages are displayed if there are no errors.
  979. The 'status parameter' must only be one of the following: ^"Under review"
  980. (default), ^"Reviewed", or ^"Rework required".
  981. The 'repository' parameter is available to set the default working
  982. repository. This is useful when the user wants to manage reviews on
  983. a server different than the one associated to the current workspace, or
  984. when there is no current workspace at all.
  985. Output format parameters (--^format option):
  986. This command accepts a format string to show the output.
  987. The output parameters of this command are the following:
  988. {0} id
  989. {1} guid
  990. Please note that the '--^format' parameter only takes effect when creating
  991. a new code review.
  992. Examples:
  993. cm ^codereview ^cs:1856@myrepo@myserver:8084 "My code review" --^assignee=dummy
  994. cm ^codereview ^br:/main/task001@myrepo@myserver:8084 "My code review" \
  995. --^status=^"Rework required" --^assignee=newbie --^format="{^id} -> {^guid}"
  996. cm ^codereview 1367 -^e --^assignee=new_assignee
  997. cm ^codereview -^e 27658884-5dcc-49b7-b0ef-a5760ae740a3 --^status=Reviewed
  998. cm ^codereview -^d 1367 --^repository=myremoterepo@myremoteserver:18084
  999. cm ^codereview 27658884-5dcc-49b7-b0ef-a5760ae740a3 -^d
  1000. == CMD_DESCRIPTION_CRYPT ==
  1001. Encrypts a password.
  1002. == CMD_USAGE_CRYPT ==
  1003. Usage:
  1004. cm ^crypt <mypassword>
  1005. mypassword Password to be encrypted.
  1006. == CMD_HELP_CRYPT ==
  1007. Remarks:
  1008. This command encrypts a given password passed as argument.
  1009. It is designed to encrypt passwords in configuration files and increase
  1010. safety.
  1011. Examples:
  1012. cm ^crypt dbconfpassword -> ENCRYPTED: encrypteddbconfpassword
  1013. (Encrypts the password in the database configuration file: 'db.conf'.)
  1014. == CMD_DESCRIPTION_DEACTIVATEUSER ==
  1015. Deactivates a licensed user.
  1016. == CMD_USAGE_DEACTIVATEUSER ==
  1017. Usage:
  1018. cm ^deactivateuser | ^du <usr_name>[ ...] [--^server=<name:port>]
  1019. [--^nosolveuser]
  1020. usr_name The user name(s) to deactivate. Use a whitespace to
  1021. separate user names.
  1022. If SID, then '--^nosolveuser' is required.
  1023. Options:
  1024. --^server Deactivates the user on the specified server.
  1025. If no server is specified, executes the command on the
  1026. one configured on the client.
  1027. --^nosolveuser With this option, the command will not check whether
  1028. the user name exists on the authentication system. The
  1029. <usr_name> must be a user SID.
  1030. == CMD_HELP_DEACTIVATEUSER ==
  1031. Remarks:
  1032. This command sets a user to inactive, disabling the usage of Plastic SCM
  1033. for that user.
  1034. See the 'cm ^activateuser' command for more information about activating
  1035. Plastic SCM users.
  1036. This command checks whether the user exists on the underlying authentication
  1037. system (e.g. ActiveDirectory, LDAP, User/Password...).
  1038. To force the deactivation of a user that no longer exists on the
  1039. authentication system, you can use the '--^nosolveuser' option.
  1040. Examples:
  1041. cm ^deactivateuser john
  1042. cm ^du peter "mary collins"
  1043. cm ^deactivateuser john --^server=myserver:8084
  1044. cm ^deactivateuser S-1-5-21-3631250224-3045023395-1892523819-1107 --^nosolveuser
  1045. == CMD_DESCRIPTION_DIFF ==
  1046. Shows differences between files, changesets, and labels.
  1047. == CMD_USAGE_DIFF ==
  1048. Usage:
  1049. cm ^diff <csetspec> | <lbspec> | <shspec> [<csetspec> | <lbspec> | <shspec>]
  1050. [<path>]
  1051. [--^added] [--^changed] [--^moved] [--^deleted]
  1052. [--^repositorypaths] [--^download=<download_path>]
  1053. [--^encoding=<name>]
  1054. [--^comparisonmethod=(^ignoreeol | ^ignorewhitespaces |
  1055. ^ignoreeolandwhitespaces | ^recognizeall)]
  1056. [--^clean]
  1057. [--^format=<str_format>] [--^dateformat=<str_format>]
  1058. Shows differences between a 'source' changeset or shelveset, and a
  1059. 'destination' changeset or shelveset. The changesets can be specified
  1060. using either a changeset or label specification.
  1061. Where two specifications are given, the first will be the 'source' of
  1062. the diff; the second, the 'destination'.
  1063. If only one specification is given, the 'source' will be the parent
  1064. changeset of the specified 'destination'.
  1065. If an optional path is specified, the Diff window will launch to show
  1066. differences between the two revision of that file.
  1067. cm ^diff <revspec1> <revspec2>
  1068. Shows differences between a pair of revisions. The differences are
  1069. shown in the Diff window. The first revision specified will appear on
  1070. the left.
  1071. cm ^diff <brspec> [--^added] [--^changed] [--^moved] [--^deleted]
  1072. [--^repositorypaths] [--^download=<download_path>]
  1073. [--^encoding=<name>]
  1074. [--^comparisonmethod=(^ignoreeol | ^ignorewhitespaces |
  1075. ^ignoreeolandwhitespaces | ^recognizeall)]
  1076. [--^clean]
  1077. [--^format=<str_format>] [--^dateformat=<str_format>]
  1078. [--^fullpaths | --^fp]
  1079. Shows the branch differences.
  1080. (Use 'cm ^help ^objectspec' to learn more about specs.)
  1081. Options:
  1082. --^added Prints only differences consisting of items added to
  1083. the repository.
  1084. --^changed Prints only differences consisting of items that
  1085. changed.
  1086. --^moved Prints only differences consisting of moved or renamed
  1087. items.
  1088. --^deleted Prints only differences consisting of items that were
  1089. deleted.
  1090. If '--^added', '--^changed', '--^moved' or '--^deleted' are
  1091. not specified, then the command prints all differences.
  1092. '^A' means added items.
  1093. '^C' means changed items.
  1094. '^D' means deleted items.
  1095. '^M' means moved items. The left item is the original,
  1096. the right is the destination.
  1097. --^repositorypaths Prints repository paths instead of workspace paths.
  1098. (This option overrides the '--^fullpaths' option.)
  1099. --^download Stores the differences content in the specified output
  1100. path.
  1101. --^encoding Specifies the output encoding, i.e.: utf-8.
  1102. See the MSDN documentation at
  1103. http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx
  1104. to get the table of supported encodings and its format,
  1105. (at the end of the page, in the "Name" column).
  1106. --^comparisonmethod Sets the specified comparison method. See Remarks for more info.
  1107. --^clean Does not take into account the differences generated
  1108. because of a merge, but only the differences created by
  1109. simple checkins.
  1110. --^format Retrieves the output message in a specific format. See
  1111. Remarks for more info.
  1112. --^dateformat Format used to output dates.
  1113. --^fullpaths, --^fp Forces printing full workspace paths for files and
  1114. directories when possible.
  1115. == CMD_HELP_DIFF ==
  1116. Remarks:
  1117. Comparison methods (--^comparisonmethod option):
  1118. ^ignoreeol Ignores the end of line differences.
  1119. ^ignorewhitespaces Ignores the whitespace differences.
  1120. ^ignoreeolandwhitespaces Ignores the end of line and whitespace differences.
  1121. ^recognizeall Detects the end of line and whitespace differences.
  1122. This command accepts a format string to show the output.
  1123. The parameters of this command are the following:
  1124. {^path} Item path.
  1125. {^date} Change date/time.
  1126. {^owner} Change author.
  1127. {^revid} Revision id of the revision considered as the
  1128. destination in the diff.
  1129. {^parentrevid} Revision id of the parent of the revision considered
  1130. as the destination of the diff.
  1131. {^baserevid} Revision id of the revision considered as the source
  1132. in the diff.
  1133. {^srccmpath} Server path before moving the item (move operation).
  1134. {^dstcmpath} Server path after moving the item (move operation).
  1135. {^type} Item type:
  1136. ^D directory,
  1137. ^B binary file,
  1138. ^F text file,
  1139. ^S symlink,
  1140. ^X Xlink.
  1141. {^repository} Repository of the item.
  1142. {^status} Item status:
  1143. ^A added,
  1144. ^D deleted,
  1145. ^M moved,
  1146. ^C changed.
  1147. {^fsprotection} Shows item permissions (Linux/Mac chmod).
  1148. {^srcfsprotection} Shows parent revision item permissions.
  1149. {^newline} Inserts a new line.
  1150. Notes on '^revid':
  1151. For added items, the '^baserevid' and '^parentrevid' will be -1, as no
  1152. previous revision exists in this case.
  1153. For deleted items, the '^revid' is the id of the source revision, and the
  1154. '^baserevid' will be -1, as there is no destination revision.
  1155. For Xlinks, both '^baserevid' and '^parentrevid' are always -1.
  1156. Examples:
  1157. Comparing branches:
  1158. cm ^diff ^br:/main/task001
  1159. cm ^diff ^br:/main/task001 \doc\readme.txt
  1160. Comparing changeset trees:
  1161. cm ^diff 19
  1162. cm ^diff 19 25
  1163. cm ^diff ^cs:19 ^cs:25 --^format="{^path} {^parentrevid}"
  1164. cm ^diff ^cs:19 ^cs:23 --^format="{^date} {^path}" --^dateformat="yy/dd/MM HH:mm:ss"
  1165. cm ^diff ^cs:19 ^cs:23 --^changed
  1166. cm ^diff ^cs:19 ^cs:23 --^repositorypaths
  1167. cm ^diff ^cs:19 ^cs:23 --^download="D:\temp"
  1168. cm ^diff ^cs:19 ^cs:23 --^clean
  1169. cm ^diff ^cs:19 ^cs:23 \doc\readme.txt
  1170. Comparing label trees:
  1171. cm ^diff ^lb:FirstReleaseLabel ^lb:SecondReleaseLabel
  1172. cm ^diff ^lb:tag_193.2 ^cs:34214
  1173. cm ^diff ^cs:31492 ^lb:tag_193.2
  1174. Comparing shelve trees:
  1175. cm ^diff ^sh:2
  1176. cm ^diff ^sh:2 ^sh:4
  1177. Comparing revspecs:
  1178. cm ^diff ^rev:readme.txt#^cs:19 ^rev:readme.txt#^cs:20
  1179. cm ^diff ^serverpath:/doc/readme.txt#^cs:19@myrepo \
  1180. ^serverpath:/doc/readme.txt#^br:/main@myrepo@localhost:8084
  1181. cm ^diff ^rev:foo.c#^cs:1 ^rev:foo.c#^cs:2 --^comparisonmethod=^ignoreeol
  1182. == CMD_DESCRIPTION_DIFFMETRICS ==
  1183. Shows diff metrics between two revs.
  1184. == CMD_USAGE_DIFFMETRICS ==
  1185. Usage:
  1186. cm ^diffmetrics | ^dm <revspec1> <revspec2> [--^format=<str_format>]
  1187. [--^encoding=<name>]
  1188. [--^comparisonmethod=(^ignoreeol | ^ignorewhitespaces |
  1189. ^ignoreeolandwhitespaces | ^recognizeall)]
  1190. revspec Revisions used to compare.
  1191. (Use 'cm ^help ^objectspec' to learn more about rev specs.)
  1192. Options:
  1193. --^format Retrieves the output message in a specific format. See
  1194. Remarks for more info.
  1195. --^encoding Specifies the output encoding, i.e.: utf-8.
  1196. See the MSDN documentation at
  1197. http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx
  1198. to get the table of supported encodings and its format,
  1199. (at the end of the page, in the "Name" column).
  1200. --^comparisonmethod Sets the specified comparison method.
  1201. See Remarks for more info.
  1202. == CMD_HELP_DIFFMETRICS ==
  1203. Remarks:
  1204. The metrics are: number of changed, added, and deleted lines.
  1205. Output format parameters (--^format option):
  1206. This command accepts a format string to show the output.
  1207. The output parameters of this command are the following:
  1208. {0} Number of changed lines.
  1209. {1} Number of added lines.
  1210. {2} Number of deleted lines.
  1211. Comparison methods (--^comparisonmethod option):
  1212. ^ignoreeol Ignores the end of line differences.
  1213. ^ignorewhitespaces Ignores the whitespace differences.
  1214. ^ignoreeolandwhitespaces Ignores the end of line and whitespace differences.
  1215. ^recognizeall Detects the end of line and whitespace differences.
  1216. Examples:
  1217. cm ^diffmetrics file.txt#^cs:2 file.txt#^br:/main/scm0211 \
  1218. --^format="There are {0} changed, {1} added and {2} deleted lines."
  1219. (Retrieves diffmetrics results formatted.)
  1220. cm ^dm file.txt#^cs:2 file.txt#^cs:3 --^encoding=utf-8 --^comparisonmethod=^ignorewhitespaces
  1221. == CMD_DESCRIPTION_FASTEXPORT ==
  1222. Exports a repository in fast-export format.
  1223. == CMD_USAGE_FASTEXPORT ==
  1224. Usage:
  1225. cm ^fast-export | ^fe <repspec> <fast-export-file>
  1226. [--^import-marks=<marks_file>]
  1227. [--^export-marks=<marks_file>]
  1228. [--^branchseparator=<chr_separator>]
  1229. [--^nodata] [--^from=<changesetid>] [--^to=<changesetid>]
  1230. Options:
  1231. repspec The repository which the data will be exported from.
  1232. (Use 'cm ^help ^objectspec' to learn more about rep specs.)
  1233. fast-export-file The file with the repository data in Git fast-export
  1234. format.
  1235. --^import-marks The marks file used for incremental imports. This file
  1236. has been previously exported by '--^export-marks'. The
  1237. changesets described in this file will not be imported
  1238. because they were already in a previous import.
  1239. --^export-marks The file where the imported changesets will be saved.
  1240. This file is used in a later fast-import to signal the
  1241. changesets that have been already imported.
  1242. --^branchseparator Plastic SCM uses "/" as default separator in the branch
  1243. hierarchy. This option allows using char as a hierarchy
  1244. separator, so main-task-sub would be mapped in Plastic
  1245. SCM as /main/task/sub.
  1246. --^nodata Exports the repository without including the data. This
  1247. is useful to check if the export will run correctly.
  1248. --^from Exports from a particular changeset.
  1249. --^to Exports to a particular changeset.
  1250. == CMD_HELP_FASTEXPORT ==
  1251. Remarks:
  1252. - To import a Plastic SCM repository to Git, use a command such as:
  1253. ^cat repo.fe.00 | ^git ^fast-import --^export-marks=marks.git --^import-marks=marks.git
  1254. - Incremental export is supported using a marks file that contains the
  1255. changesets previously imported ('--^import-marks' and '--^export-marks'
  1256. files).
  1257. This means that only the new changesets that were not exported in the
  1258. previous fast-export will be exported.
  1259. Examples:
  1260. cm ^fast-export repo@localhost:8087 repo.fe.00 --^import-marks=marks.cm \
  1261. --^export-marks=marks.cm
  1262. (Exports the repository 'repo' in the local server into the 'repo.fe.00'
  1263. file in Git fast-export format and creates the marks files to perform
  1264. incremental exports later.)
  1265. cm ^fast-export repo@localhost:8087 repo.fe.00 --^from=20
  1266. (Exports the repository 'repo' in the local server into the 'repo.fe.00'
  1267. file in Git fast-export format from changeset '20'.)
  1268. == CMD_DESCRIPTION_FASTIMPORT ==
  1269. Imports Git fast-export data into a repository.
  1270. == CMD_USAGE_FASTIMPORT ==
  1271. Usage:
  1272. cm ^fast-import | ^fi <repspec> <fast-export-file>
  1273. [--^import-marks=<marks_file>]
  1274. [--^export-marks=<marks_file>]
  1275. [--^stats] [--^branchseparator=<chr_separator>]
  1276. [--^nodata] [--^ignoremissingchangesets] [--^mastertomain]
  1277. Options:
  1278. repspec The repository into which the data will be
  1279. imported. It is created if it did not previously
  1280. exist. (Use 'cm ^help ^objectspec' to learn more
  1281. about rep specs.)
  1282. fast-export-file The file with the repository data in Git
  1283. fast-export format.
  1284. --^import-marks The marks file used for incremental imports.
  1285. This file has been previously exported by
  1286. '--^export-marks'. The changesets described in
  1287. this file wont be imported because they
  1288. were already in a previous import.
  1289. --^export-marks The file where the imported changesets will
  1290. be saved. This file is used in a later
  1291. fast-import to signal the changesets that have
  1292. been already imported.
  1293. --^stats Prints some statistics about the import process.
  1294. --^branchseparator Plastic SCM uses "/" as default separator in
  1295. the branch hierarchy. This option allows using
  1296. char as a hierarchy separator, so main-task-sub
  1297. would be mapped in Plastic SCM as /main/task/sub.
  1298. --^nodata Imports Git fast-export without including the
  1299. data. This is useful to check if the import will
  1300. run correctly.
  1301. --^ignoremissingchangesets Any changesets that cannot be imported are
  1302. discarded and the fast-import operation
  1303. continues without them.
  1304. --^mastertomain Imports using "^main" instead of "^master".
  1305. == CMD_HELP_FASTIMPORT ==
  1306. Remarks:
  1307. - To export a Git repository, use a command such as:
  1308. ^git ^fast-export --^all -^M --^signed-tags=^strip --^tag-of-filtered-object=^drop> ..\git-fast-export.dat
  1309. The -^M option is important to detect moved items.
  1310. - The specified repository is created in case it did not exist.
  1311. - Incremental import is supported using a marks file that contains the
  1312. changesets previously imported ('--^import-marks' and '--^export-marks'
  1313. files).
  1314. This means that only the new changesets that were not imported in the
  1315. previous fast-import will be imported.
  1316. Examples:
  1317. cm ^fast-import mynewrepo@atenea:8084 repo.fast-export
  1318. (Imports the contents exported in the 'repo.fast-export' file into
  1319. 'mynewrepo' repository on server 'atenea:8084'.)
  1320. cm ^fast-import repo@atenea:8084 repo.fast-export --^export-marks=rep.marks
  1321. (Imports the contents exported in the 'repo.fast-export' file into
  1322. 'repo' repository on server 'atenea:8084' and creates a marks file
  1323. to perform incremental imports later.)
  1324. cm ^fast-import repo@server:8084 repo.fast-export --^import-marks=repo.marks \
  1325. --^export-marks=repo.marks
  1326. (Imports the contents of the 'repo.fast-export' file. Only the new
  1327. changesets that were not in the marks file are imported. The same marks
  1328. file is used to save the list of changesets again for the next
  1329. incremental import.)
  1330. == CMD_DESCRIPTION_FILEINFO ==
  1331. Retrieves detailed information about the items in the workspace.
  1332. == CMD_USAGE_FILEINFO ==
  1333. Usage:
  1334. cm ^fileinfo <item_path>[ ...] [--^fields=<field_value>[,...]]
  1335. [[--^xml | -^x [=<output_file>]] | [--^format=<str_format>]]
  1336. [--^symlink] [--^encoding=<name>]
  1337. item_path Items to display. Use a whitespace to separate the items.
  1338. Use double quotes (" ") to specify paths containing spaces.
  1339. Options:
  1340. --^fields A string of comma-separated values. This selects which
  1341. fields will be printed for each item. See Remarks for
  1342. more information.
  1343. --^xml | -^x Prints the output in XML format to the standard output.
  1344. It is possible to specify an output file. This option
  1345. cannot be combined with '--^format'.
  1346. --^format Retrieves the output message in a specific format. See
  1347. Remarks for more info. This option cannot be combined
  1348. with '--^xml'.
  1349. This '--^format' option prevails over '--^fields' if both
  1350. are specified.
  1351. --^symlink Applies the fileinfo operation to the symlink and not
  1352. to the target.
  1353. --^encoding Specifies the output encoding, i.e.: utf-8.
  1354. See the MSDN documentation at
  1355. http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx
  1356. to get the table of supported encodings and its format,
  1357. (at the end of the page, in the "Name" column).
  1358. == CMD_HELP_FILEINFO ==
  1359. Remarks:
  1360. This command prints a detailed list of attributes for each selected item.
  1361. Each attribute is printed on a new line by default.
  1362. The attribute list can be modified to display only the attributes the user
  1363. needs. This can be achieved using the '--^fields=<field_list>' which accepts
  1364. a string of comma-separated attribute names. This way, only those arguments
  1365. whose name has been indicated are shown.
  1366. Revision head changeset:
  1367. This option is disabled by default. Please note that retrieving this
  1368. attribute is significantly slower than the rest of them, so we advise users
  1369. to group together as many items as possible. This will improve execution
  1370. times by avoiding many separate 'cm ^fileinfo' executions.
  1371. Also, this feature is not currently available for controlled directories.
  1372. You can find below the complete list of available attribute names.
  1373. Names marked with an asterisk ('*') will not be shown by default:
  1374. ^ClientPath The local path on disk for the item.
  1375. ^RelativePath The workspace-relative path.
  1376. ^ServerPath The repository path for the item.
  1377. (Note: Transformed workspaces are not
  1378. currently supported for this option).
  1379. ^Size Item size.
  1380. ^Hash Item hash sum.
  1381. ^Owner The user the item belongs to.
  1382. ^RevisionHeadChangeset (*) The changeset of the revision loaded in the
  1383. head changeset of the branch.
  1384. (Please see note above.)
  1385. ^RevisionChangeset The changeset of the revision currently loaded
  1386. in the workspace.
  1387. ^RepSpec The repository specification for the item.
  1388. (Use 'cm ^help ^objectspec' to learn more about
  1389. rep specs.)
  1390. ^Status The workspace item status: added, checked out,
  1391. deleted, etc.
  1392. ^Type Revision type (text, binary, directory, symlink,
  1393. or unknown).
  1394. ^Changelist The changelist the item belongs to (if any).
  1395. ^IsLocked (*) Whether the item is locked by exclusive
  1396. checkout or not.
  1397. ^LockedBy (*) The user who exclusively checked out the item.
  1398. ^LockedWhere (*) The location where the item was exclusively
  1399. checked out.
  1400. ^IsUnderXlink Whether the item is located under an Xlink
  1401. or not.
  1402. ^UnderXlinkTarget The target of the Xlink the item is under
  1403. (if any).
  1404. ^UnderXlinkPath The item server path in the Xlinked repository
  1405. (if any).
  1406. ^UnderXlinkWritable Whether the Xlink the item belongs to is
  1407. writable or not.
  1408. ^UnderXlinkRelative Whether the Xlink the items belongs to is
  1409. relative or not.
  1410. ^IsXlink Whether the item itself is a Xlink or not.
  1411. ^XlinkTarget The target repository the item points to, if it
  1412. is a Xlink.
  1413. ^XlinkName The Xlink name of the item, if it is
  1414. actually one.
  1415. ^XlinkWritable Whether the Xlink item is a writable Xlink
  1416. or not.
  1417. ^XlinkRelative Whether the Xlink item is a relative Xlink
  1418. or not.
  1419. Output format parameters (--^format option):
  1420. This command accepts a format string to show the output.
  1421. The output parameters of this command are the following:
  1422. {^ClientPath}
  1423. {^RelativePath}
  1424. {^ServerPath}
  1425. {^Size}
  1426. {^Hash}
  1427. {^Owner}
  1428. {^RevisionHeadChangeset}
  1429. {^RevisionChangeset}
  1430. {^Status}
  1431. {^Type}
  1432. {^Changelist}
  1433. {^IsLocked}
  1434. {^LockedBy}
  1435. {^LockedWhere}
  1436. {^IsUnderXlink}
  1437. {^UnderXlinkTarget}
  1438. {^UnderXlinkPath}
  1439. {^UnderXlinkWritable}
  1440. {^UnderXlinkRelative}
  1441. {^IsXlink}
  1442. {^XlinkTarget}
  1443. {^XlinkName}
  1444. {^XlinkWritable}
  1445. {^XlinkRelative}
  1446. {^RepSpec}
  1447. Please note that '--^format' and '--^xml' options are mutually exclusive, so
  1448. they can't be used at the same time.
  1449. Examples:
  1450. cm ^fileinfo file1.txt file2.txt dir/
  1451. cm ^fileinfo "New Project.csproj" --^xml
  1452. cm ^fileinfo assets.art --^fields=^ServerPath,^Size,^IsLocked,^LockedBy
  1453. cm ^fileinfo proj_specs.docx --^fields=^ServerPath,^RevisionChangeset --^xml
  1454. cm ^fileinfo samples.ogg --^format="{^ServerPath}[{^Owner}] -> {^Size}"
  1455. == CMD_DESCRIPTION_FIND_QUERY ==
  1456. Runs SQL-like queries to find Plastic SCM objects.
  1457. == CMD_USAGE_FIND_QUERY ==
  1458. Usage:
  1459. cm ^find <object_type>
  1460. [^where <str_conditions>]
  1461. [^on ^repository '<repspec>' | ^on ^repositories '<repspec1>','<repspec2>'[,...]]
  1462. [^order ^by <sort_field> ['^asc' | '^desc']]
  1463. [[^limit <maxresults>] [^offset <offset>]]
  1464. [--^format=<str_format>] [--^dateformat=<date_format>]
  1465. [--^nototal] [--^file=<dump_file>] [--^xml]
  1466. [--^encoding=<name>]
  1467. object_type Object type to find.
  1468. Some of these objects are implementing the '^order ^by' clause.
  1469. Use 'cm ^help ^showfindobjects' to learn how to specify these
  1470. objects, the ones allowing '^order ^by' and by what fields.
  1471. You can also read the 'cm ^find' guide:
  1472. https://www.plasticscm.com/download/help/cmfind
  1473. Options:
  1474. str_conditions Searches conditions on an object attributes.
  1475. repspec Searches repositories alias or specification.
  1476. In the case of '^on ^repositories', use a comma to
  1477. separate the repspec fields.
  1478. (Use 'cm ^help ^objectspec' to learn more about repository
  1479. specifications.)
  1480. sort_field The name of the field to use as sorting field. Mind there is only
  1481. a subset of field possibilities. Use 'cm ^help ^showfindobjects'
  1482. to find what objects are allowed to be ordered and by what fields.
  1483. maxresults The maximun number of results returned by the query.
  1484. offset The number of rows to skip before starting to return results
  1485. from the query.
  1486. --^format Retrieves the output message in a specific format.
  1487. Read the 'cm ^find' guide to see all the object
  1488. attributes that can be used as output format strings:
  1489. https://www.plasticscm.com/download/help/cmfind
  1490. --^dateformat Format used to output dates.
  1491. --^nototal Does not output record count at the end.
  1492. --^file File to dump results.
  1493. --^xml Prints the output in XML format to the standard output.
  1494. --^encoding Specifies the output encoding, i.e.: utf-8.
  1495. See the MSDN documentation at
  1496. http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx
  1497. to get the table of supported encodings and its format,
  1498. (at the end of the page, in the "Name" column).
  1499. == CMD_HELP_FIND_QUERY ==
  1500. Remarks:
  1501. If no repository is specified, the search is made on the repository
  1502. configured in the workspace.
  1503. When you run queries using comparison operators (>, <, >=, <=) from the
  1504. command line, remember that the shell considers these operators as IO
  1505. redirections. So you will need to enclose the queries in double quotation
  1506. marks.
  1507. The 'cm ^find' command accepts a format string to show the output.
  1508. Each output parameter is identified by a string and the user can refer it
  1509. by typing the parameter number between '{' and '}' brackets.
  1510. Output parameters usually correspond to the attributes of the object.
  1511. These are some valid output format strings:
  1512. --^format={^id}{^date}{^name}
  1513. --^format="{^item}#{^branch} ^with ^date {^date}"
  1514. XML and encoding considerations:
  1515. When the '--^xml' option is specified, the command shows the command result
  1516. as an XML text in the standard output. The operating system default encoding
  1517. is used to show the text, so it is possible that not-ANSI characters are
  1518. incorrectly visualized in the console. If you redirect the command output to
  1519. a file, it will be correctly visualized. When both '--^xml' and '--^file'
  1520. options are specified, the default encoding will be utf-8.
  1521. Examples:
  1522. cm ^find ^revision
  1523. cm ^find ^revision "^where ^changeset=23 ^and ^owner='maria'"
  1524. cm ^find ^branch "^on ^repository 'rep1'"
  1525. cm ^find ^label "^on ^repositories 'rep1', '^rep:default@localhost:8084'"
  1526. cm ^find ^branch "^where ^parent='^br:/main' ^on ^repository 'rep1'"
  1527. cm ^find ^revision "^where ^item='^item:.'" --^format="{^item}#{^branch}"
  1528. cm ^find ^revision "^where ^item='^item:.'" --^xml --^file=c:\queryresults\revs.xml
  1529. cm ^find ^label "^where ^owner='^me' ^limit 10 ^offset 20"
  1530. cm ^find ^branches "^where ^owner='^me' ^order ^by ^branchname ^desc ^limit 10"
  1531. == CMD_DESCRIPTION_FINDCHANGED ==
  1532. Gets a list of changed files. This command is deprecated and kept just for
  1533. backwards compatibility. Use 'cm ^status' instead.
  1534. == CMD_USAGE_FINDCHANGED ==
  1535. Usage:
  1536. cm ^findchanged | ^fc [-^R | -^r | --^recursive] [--^checkcontent]
  1537. [--^onlychanged] [<path>]
  1538. Options:
  1539. -^R Recursively finds in directories.
  1540. --^checkcontent Compares files by content.
  1541. --^onlychanged Finds only changed files; checkouts will not be
  1542. obtained.
  1543. path (Default: current directory.)
  1544. Initial path to find changed files.
  1545. == CMD_HELP_FINDCHANGED ==
  1546. Remarks:
  1547. If no '--^checkcontent' option is given, Plastic finds changes based on the
  1548. file timestamp.
  1549. When '--^checkcontent' option is specified, the file or folder contents are
  1550. compared, instead of using the timestamp.
  1551. This command is useful to detect changed files while disconnected from
  1552. the Plastic SCM server.The output can be piped to the ^checkout command,
  1553. to check the changes later (see examples).
  1554. Examples:
  1555. cm ^findchanged .
  1556. (Finds changed files in the current directory.)
  1557. cm ^findchanged -^R . | cm ^checkout -
  1558. (Checkouts changed elements.)
  1559. == CMD_DESCRIPTION_FINDCHECKEDOUT ==
  1560. Gets a list of checked out items. This command is deprecated and kept just for
  1561. backwards compatibility. Use 'cm ^status' instead.
  1562. == CMD_USAGE_FINDCHECKEDOUT ==
  1563. Usage:
  1564. cm ^findcheckouts | ^fco [--^format=<str_format>] [--^basepath]
  1565. Options:
  1566. --^format Retrieves the output message in a specific format. See
  1567. Remarks for more info.
  1568. --^basepath The path to start searching checkouts from. If not
  1569. specified, the current path is used.
  1570. == CMD_HELP_FINDCHECKEDOUT ==
  1571. Remarks:
  1572. This command is useful to checkin or undocheckout all checked out items in
  1573. one single step, redirecting the standard output to other command.
  1574. See examples.
  1575. Output format parameters (--^format option):
  1576. This command accepts a format string to show the output.
  1577. The output parameters of this command are the following:
  1578. {0} Date.
  1579. {1} Owner.
  1580. {2} Workspace info.
  1581. {3} Client machine name.
  1582. {4} Item path.
  1583. {5} Branch and repository info.
  1584. Examples:
  1585. cm ^findcheckouts --^format="File {4} changed on branch {5}"
  1586. (Finds checked out items and formats the output with file path and branch
  1587. and repository info.)
  1588. cm ^findcheckouts --^format={4} | cm ^checkin -
  1589. (Checkins all checked out items.)
  1590. cm ^findcheckouts --^format={4} | cm ^undocheckout -
  1591. (Undocheckouts of all checked out items.)
  1592. == CMD_DESCRIPTION_FINDPRIVATE ==
  1593. Gets a list of private items. This command is deprecated and kept just for
  1594. backwards compatibility. Use 'cm ^status' instead.
  1595. == CMD_USAGE_FINDPRIVATE ==
  1596. Usage:
  1597. cm ^findprivate | ^fp [-^R | -^r | --^recursive] [--^exclusions] [<path>]
  1598. Options:
  1599. -^R Recursively finds in directories.
  1600. --^exclusions This option allows cutting the search inside the ignored
  1601. paths, defined by the file ignore.conf.
  1602. path (Default: current directory.)
  1603. Initial path to find private files.
  1604. == CMD_HELP_FINDPRIVATE ==
  1605. Remarks:
  1606. If any path is specified, Plastic SCM will begin searching from the
  1607. current directory.
  1608. This command is useful to add private items on a folder, piping the output
  1609. to the '^add' command. See examples.
  1610. Examples:
  1611. cm ^findprivate .
  1612. cm ^findprivate -^R | cm ^add -
  1613. (Recursively searches private items and add them.)
  1614. == CMD_DESCRIPTION_GETCONFIG ==
  1615. Obtains configuration info.
  1616. == CMD_USAGE_GETCONFIG ==
  1617. Usage:
  1618. cm ^getconfig [^setfileasreadonly] [^location] [^extensionworkingmode]
  1619. [^extensionprefix] [^defaultrepserver]
  1620. ^setfileasreadonly Returns whether the protected files are left as
  1621. read-only or not.
  1622. ^location Returns the client config path.
  1623. ^extensionworkingmode Returns the extension working mode.
  1624. ^extensionprefix Returns the configured extension prefix.
  1625. ^defaultrepserver Returns the location of the default repository
  1626. server.
  1627. == CMD_HELP_GETCONFIG ==
  1628. Examples:
  1629. cm ^getconfig ^setfileasreadonly
  1630. == CMD_DESCRIPTION_GETFILE ==
  1631. Downloads the content of a given revision.
  1632. == CMD_USAGE_GETFILE ==
  1633. Usage:
  1634. cm ^getfile | ^cat <revspec> [--^file=<output_file>] [--^debug]
  1635. [--^symlink] [--^raw]
  1636. revspec Object specification. (Use 'cm ^help ^objectspec' to learn
  1637. more about specs.)
  1638. Options:
  1639. --^file File to save the output. By default, it is printed on the
  1640. standard output.
  1641. --^debug When a directory specification is used, the command
  1642. shows all the items in the directory, its revision id
  1643. and file system protection.
  1644. --^symlink Applies the operation to the symlink and not to the
  1645. target.
  1646. --^raw Displays the raw data of the file.
  1647. == CMD_HELP_GETFILE ==
  1648. Examples:
  1649. cm ^cat myfile.txt#^br:/main
  1650. (Obtains the last revision in branch '^br:/main' of 'myfile.txt'.)
  1651. cm ^getfile myfile.txt#^cs:3 --^file=tmp.txt
  1652. (Obtains the changeset 3 of 'myfile.txt' and write it to file 'tmp.txt'.)
  1653. cm ^cat ^serverpath:/src/foo.c#^br:/main/task003@myrepo
  1654. (Obtains the contents of '/src/foo.c' at the last changeset of branch
  1655. '/main/task003' in repository 'myrepo'.)
  1656. cm ^cat ^revid:1230@^rep:myrep@^repserver:myserver:8084
  1657. (Obtains the revision with id 1230.)
  1658. cm ^getfile ^rev:info\ --^debug
  1659. (Obtains all revisions in the 'info' directory.)
  1660. == CMD_DESCRIPTION_GETREVISION ==
  1661. Loads a revision in the workspace.
  1662. == CMD_USAGE_GETREVISION ==
  1663. This command modifies the revision loaded in the workspace, so it can affect
  1664. future merges.
  1665. It is an advanced command inherited from old versions, so use it with care.
  1666. Usage:
  1667. cm ^getrevision <revspec>
  1668. revspec Object specification. (Use 'cm ^help ^objectspec' to learn
  1669. more about rev specs.)
  1670. == CMD_HELP_GETREVISION ==
  1671. Examples:
  1672. cm ^getrevision file.txt#^cs:3
  1673. (Gets changeset 3 revision of 'file.txt'.)
  1674. == CMD_DESCRIPTION_GETSTATUS ==
  1675. Gets the status of an item.
  1676. == CMD_USAGE_GETSTATUS ==
  1677. This is an automation command, meant to be used to automate 'cm' only.
  1678. It is not as user-friendly as it should be.
  1679. Usage:
  1680. cm ^getstatus | ^gs <item_path>[ ...] [--^format=<str_format>] [--^stats]
  1681. [-^R | -^r | --^recursive]
  1682. item_path Item or items to get status from. Use double quotes
  1683. (" ") to specify paths containing spaces. Use a
  1684. whitespace to separate paths.
  1685. Options:
  1686. --^format Retrieves the output message in a specific format. See
  1687. Remarks for more info.
  1688. --^stats Prints some statistics about the get status process.
  1689. -^R Shows recursively the status in directories.
  1690. == CMD_HELP_GETSTATUS ==
  1691. Remarks:
  1692. Output format parameters (--^format option):
  1693. This command accepts a format string to show the output.
  1694. The output parameters of this command are the following:
  1695. {0} Item path.
  1696. {1} Item status:
  1697. 0 private,
  1698. 1 checked in,
  1699. 2 checked out.
  1700. Reading input from stdin:
  1701. The '^getstatus' command can read paths from stdin. To do this, pass a
  1702. single dash "-".
  1703. Example: cm ^getstatus -
  1704. Paths will be read until an empty line is entered.
  1705. This allows you to use pipe to specify which paths to get the status for.
  1706. Example:
  1707. dir /S /B *.c | cm ^getstatus --^format="Path {0} Status {1}" -
  1708. (In Windows, gets the status of all .c files in the workspace.)
  1709. Examples:
  1710. cm ^getstatus file1.txt file2.txt
  1711. (Gets the status of the files.)
  1712. cm ^gs info\ -^R --^format="The item {0} has the status {1}"
  1713. (Gets the status of the directory and all of its items and shows a
  1714. formatted output.)
  1715. == CMD_DESCRIPTION_GETTASKBRANCHES ==
  1716. Gets branches linked with a task.
  1717. == CMD_USAGE_GETTASKBRANCHES ==
  1718. This is an automation command, meant to be used to automate 'cm' only.
  1719. It is not as user-friendly as it should be.
  1720. Usage:
  1721. cm ^gettaskbranches | ^gtb <task_name> [--^format=<str_format>]
  1722. [--^dateformat=<date_format>]
  1723. task_name The task identifier.
  1724. Options:
  1725. --^format Retrieves the output message in a specific format. See
  1726. Remarks for more info.
  1727. --^dateformat Format used to output dates.
  1728. == CMD_HELP_GETTASKBRANCHES ==
  1729. Remarks:
  1730. Output format parameters (--^format option):
  1731. This command accepts a format string to show the output.
  1732. The output parameters of this command are the following:
  1733. {^tab} Inserts a tab space.
  1734. {^newline} Inserts a new line.
  1735. {^name} Branch name.
  1736. {^owner} Owner of the branch.
  1737. {^date} Date when the branch was created.
  1738. {^parent} Parent branch.
  1739. {^comment} Comment of the branch.
  1740. {^repname} Repository where the branch exists.
  1741. {^repserver} Server name.
  1742. Examples:
  1743. cm ^gettaskbranches 4311
  1744. cm ^gtb 4311 --^format="^br:{^name}"
  1745. cm ^gtb 4311 --^format="^br:{^name} {^date}" --^dateformat="yyyy/MM/dd HH:mm:ss"
  1746. == CMD_DESCRIPTION_GETWWI ==
  1747. Shows info about the workspace selector.
  1748. == CMD_USAGE_GETWWI ==
  1749. Usage:
  1750. cm ^workspaceinfo | ^wi [<wk_path>]
  1751. Options:
  1752. wk_path Path of a workspace on the machine.
  1753. == CMD_HELP_GETWWI ==
  1754. Remarks:
  1755. The '^wi' command shows the working configuration of a workspace (repository,
  1756. branch, and/or label).
  1757. Examples:
  1758. cm ^wi c:\mywk
  1759. == CMD_DESCRIPTION_GWP ==
  1760. Gets workspace info from a path.
  1761. == CMD_USAGE_GWP ==
  1762. This is an automation command, meant to be used to automate 'cm' only.
  1763. It is not as user-friendly as it should be.
  1764. Usage:
  1765. cm ^getworkspacefrompath | ^gwp <item_path> [--^format=<str_format>] [--^extended]
  1766. item_path File or folder on disk.
  1767. Options:
  1768. --^format Retrieves the output message in a specific format. See
  1769. Remarks for more info.
  1770. --^extended Displays more information regarding the workspace: ^type
  1771. and ^dynamic on top of the others. See Remarks for more info.
  1772. == CMD_HELP_GWP ==
  1773. Remarks:
  1774. This command shows information about the workspace that is located in path.
  1775. Output format parameters (--^format option):
  1776. This command accepts a format string to show the output.
  1777. The output parameters of this command are the following:
  1778. {0} | {^wkname} Workspace name.
  1779. {1} | {^wkpath} Workspace path.
  1780. {2} | {^machine} Client machine name.
  1781. {3} | {^owner} Workspace owner.
  1782. {4} | {^guid} Workspace GUID.
  1783. {5} | {^type} Workspace type: partial (gluon) or regular.
  1784. {6} | {^dynamic} A workspace can be dynamic (plasticfs) or static.
  1785. {^tab} Inserts a tab space.
  1786. {^newline} Inserts a new line.
  1787. Examples:
  1788. cm ^gwp c:\myworkspace\code\file1.cpp --^format="Workspace name: {^wkname}"
  1789. cm ^gwp . --^format="Name: {^wkname} | Type: {^type}, {^dynamic}"
  1790. == CMD_DESCRIPTION_HELP ==
  1791. Gets help for a Plastic SCM command.
  1792. == CMD_USAGE_HELP ==
  1793. Usage:
  1794. cm ^help <command>
  1795. == CMD_HELP_HELP ==
  1796. == CMD_DESCRIPTION_IOSTATS ==
  1797. Shows statistics about the hardware.
  1798. == CMD_USAGE_IOSTATS ==
  1799. Usage:
  1800. cm ^iostats [<repserverspec>] [<list_of_tests>[ ...]]
  1801. [--^nettotalmb=<value_mb>] [--^networkiterations=<value_iter>]
  1802. [--^diskdatasize=<value_size>] [--^disktestpath=<value_path>]
  1803. [--^systemdisplaytime=<value_time>]
  1804. [--^systemdisplaytimeinterval=<value_interval>]
  1805. Options:
  1806. repserverspec An available Plastic SCM server to perform
  1807. the network tests, such as "serverUploadTest"
  1808. and/ or "serverDownloadTest".
  1809. If no server is provided, the command tries
  1810. to communicate with the server configured by
  1811. default.
  1812. (Use 'cm ^help ^objectspec' to learn more about
  1813. server specs.)
  1814. list_of_tests Available tests. Use a whitespace to separate
  1815. test fields.
  1816. See Remarks for more info.
  1817. --^nettotalmb Indicates the amount of user data (in
  1818. MegaBytes) transmitted on a network test,
  1819. such as "^serverDownloadTest" or
  1820. "^serverUploadTest".
  1821. It must be a value between "4" and "512".
  1822. (Default: 16)
  1823. --^networkiterations Indicates the number of iterations of
  1824. "^serverDownloadTest" and/or "^serverUploadTest"
  1825. that will be run.
  1826. It must be a value between "1" and "100".
  1827. (Default: 1)
  1828. --^diskdatasize Indicates the amount of data (in MegaBytes)
  1829. that will be written and then read on the
  1830. "^diskTest".
  1831. It must be a value between "100" and "4096".
  1832. (Default: 512)
  1833. --^disktestpath Path where the "^diskTest" writes the test
  1834. files. If this parameter is not provided,
  1835. the command will try to use the system temp
  1836. path.
  1837. --^systemdisplaytime Time interval (in seconds) showing the usage
  1838. of system resources. This option is available
  1839. for the following tests: "^systemNetworkUsage"
  1840. and "^systemDiskUsage".
  1841. It must be a value between "1" and "3600".
  1842. (Default: 5 seconds).
  1843. --^systemdisplaytimeinterval Time interval (in seconds) between the
  1844. system performance samples. This option is
  1845. available for the following tests:
  1846. "^systemNetworkUsage" and "^systemDiskUsage".
  1847. It must be a value between "1" and "60".
  1848. (Default: 1 second).
  1849. == CMD_HELP_IOSTATS ==
  1850. Remarks:
  1851. This command requires an available server be used during the network
  1852. speed tests ("^serverUploadTest" and/or "^serverDownloadTest").
  1853. The '--^diskTestPath' must point to a path that belongs to the physical
  1854. disk drive about to be tested. If no path is specified, the command tries
  1855. to use the system default temp path.
  1856. The disk drive of the specified path must have enough free space to execute
  1857. the test.
  1858. During the command execution, the system can experience a degraded
  1859. performance caused by the tests performed.
  1860. Available tests:
  1861. --^serveruploadtest (Default) Measures the data upload speed from
  1862. Plastic SCM client to the server.
  1863. --^serverdownloadtest (Default) Measures the data download speed from
  1864. Plastic SCM server to the client.
  1865. --^disktest (Default) Measures the disk read speed and disk
  1866. write speed.
  1867. --^systemnetworkusage Shows the current usage of system network
  1868. resources.
  1869. (It shows Network Interface performance counters
  1870. provided by Microsoft Windows).
  1871. Available in Microsoft Windows only.
  1872. --^systemdiskusage Shows the current usage of system physical
  1873. disks.
  1874. (It shows Network Interface performance counters
  1875. provided by Microsoft Windows).
  1876. Available in Microsoft Windows only.
  1877. Examples:
  1878. cm ^iostats MYSERVER:8087 --^serveruploadtest --^serverdownloadtest --^nettotalmb=32
  1879. == CMD_DESCRIPTION_ISSUETRACKER ==
  1880. Gets, updates, or finds the issue status in the specified issue tracker.
  1881. == CMD_USAGE_ISSUETRACKER ==
  1882. Usage:
  1883. cm ^issuetracker <name> ^status ^get <task_id> <parameter>[ ...]
  1884. cm ^issuetracker <name> ^status ^update <task_id> <status> <parameter>[ ...]
  1885. cm ^issuetracker <name> ^status ^find <status> <parameter>[ ...]
  1886. cm ^issuetracker <name> ^connection ^check <parameter>[ ...]
  1887. name Name of the issue tracker to connect with.
  1888. Only Jira is supported at the moment.
  1889. task_id Number of the issue to query or update.
  1890. ^status A valid status for an issue in the issue tracker.
  1891. Jira parameters (all are mandatory):
  1892. --^user=<user> The user to authenticate.
  1893. --^password=<password> The password to authenticate.
  1894. --^host=<url> The target url of the issue tracker.
  1895. --^projectkey=<key> The project key of Jira project.
  1896. == CMD_HELP_ISSUETRACKER ==
  1897. Examples:
  1898. cm ^issuetracker jira ^status ^get 11 --^user=user@mail.es --^password=pwd \
  1899. --^host=https://user.atlassian.net --^projectkey=PRJ
  1900. (Gets the status of the issue 11 for the 'PRJ' project.)
  1901. cm ^issuetracker jira ^status ^update 11 "Done" --^user=user@mail.es \
  1902. --^password=pwd --^host=https://user.atlassian.net --^projectkey=PRJ
  1903. (Updates the status to 'Done' of the issue 11 for the 'PRJ' project.)
  1904. cm ^issuetracker jira ^status ^find "Done" --^user=user@mail.es --^password=pwd \
  1905. --^host=https://user.atlassian.net --^projectkey=PRJ
  1906. (Gets the task ids whose status is set to 'Done' for the 'PRJ' project.)
  1907. cm ^issuetracker jira ^connection ^check --^user=user@mail.es --^password=pwd \
  1908. --^host=https://user.atlassian.net --^projectkey=PRJ
  1909. (Checks whether the configuration parameters are valid or not.)
  1910. == CMD_DESCRIPTION_LICENSEINFO ==
  1911. Displays license information and license usage.
  1912. == CMD_USAGE_LICENSEINFO ==
  1913. Usage:
  1914. cm ^licenseinfo | ^li [--^server=<repserverspec>] [--^inactive] [--^active]
  1915. [--^sort=(^name|^status)]
  1916. Options:
  1917. --^server Gets the license info from the specified server.
  1918. If no server is specified, executes the command on the
  1919. one configured on the client.
  1920. (Use 'cm ^help ^objectspec' to learn more about repserver
  1921. specs.)
  1922. --^inactive Shows only inactive users in the "license usage" section.
  1923. --^active Shows only active users in the "license usage" section.
  1924. --^sort Sorts users by one of the specified sort options:
  1925. '^name' or '^status'.
  1926. == CMD_HELP_LICENSEINFO ==
  1927. Remarks:
  1928. The information displayed consists of expiration date, activated and
  1929. deactivated users, etc.
  1930. Examples:
  1931. cm ^licenseinfo
  1932. cm ^licenseinfo --^server=myserver:8084
  1933. cm ^licenseinfo --^sort=^name
  1934. == CMD_DESCRIPTION_LINKTASK ==
  1935. Links a changeset to a task.
  1936. == CMD_USAGE_LINKTASK ==
  1937. This is an automation command, meant to be used to automate 'cm' only.
  1938. It is not as user friendly as it should be.
  1939. Usage:
  1940. cm ^linktask | ^lt <csetspec> <ext_prefix> <task_name>
  1941. csetspec The full changeset specification to link to a task.
  1942. (Use 'cm ^help ^objectspec' to learn more about changeset
  1943. specs.)
  1944. ext_prefix The extension prefix of the configured issue tracking
  1945. system to work with.
  1946. task_name The task identifier on the issue tracking system.
  1947. == CMD_HELP_LINKTASK ==
  1948. Examples:
  1949. cm ^lt ^cs:8@^rep:default@^repserver:localhost:8084 jira PRJ-1
  1950. == CMD_DESCRIPTION_LOCK_LIST ==
  1951. Shows locks on a server.
  1952. == CMD_USAGE_LOCK_LIST ==
  1953. Usage:
  1954. cm ^lock ^list | ^ls [<revspec> [ ...]] [--^server=<server>]
  1955. [--^onlycurrentuser] [--^onlycurrentworkspace]
  1956. [--^ignorecase]
  1957. [--^machinereadable [--^startlineseparator=<sep>]
  1958. [--^endlineseparator=<sep>] [--^fieldseparator=<sep>]]
  1959. revspec If one or more are present, this command will display
  1960. one lock line for each specified revision if its
  1961. associated item is locked in the server. Otherwise,
  1962. this command will list all locked items in the default
  1963. server (or the one set with the '--^server' option).
  1964. Use a whitespace to separate the rev specs when using
  1965. more than one.
  1966. (Use 'cm ^help ^objectspec' to learn more about rev specs.)
  1967. Options:
  1968. --^server Repository server specification.
  1969. This option will override the default server which
  1970. is retrieved from the current workspace or the
  1971. client.conf file.
  1972. (Use 'cm ^help ^objectspec' to learn more about
  1973. server specs.)
  1974. --^onlycurrentuser Filters the results showing only the locks performed
  1975. by the current user.
  1976. --^onlycurrentworkspace Filters the results showing only the locks performed
  1977. on the current workspace (matching them by name).
  1978. --^ignorecase Ignores casing on the paths when a serverpath spec
  1979. is used. With this flag, the command will work for
  1980. "/src/foo.c" even if the user writes "/sRc/fOO.c".
  1981. --^machinereadable Outputs the result in an easy-to-parse format.
  1982. --^startlineseparator Used with the '--^machinereadable' flag, specifies how
  1983. the lines should start.
  1984. --^endlineseparator Used with the '--^machinereadable' flag, specifies how
  1985. the lines should end.
  1986. --^fieldseparator Used with the '--^machinereadable' flag, specifies how
  1987. the fields should be separated.
  1988. == CMD_HELP_LOCK_LIST ==
  1989. Remarks:
  1990. The command will display a list of the currently locked items in the
  1991. default server. It also accepts a list of revision specifications. In this
  1992. case, only the locks belonging to the selected items will be displayed.
  1993. A '--^server=<server>' can be used to set the default server to query.
  1994. The command shows a line for every lock in the specified server:
  1995. - GUID of the locked item.
  1996. - User name who performed the lock.
  1997. - Workspace name where the lock was performed.
  1998. - Path of the locked item (server path format).
  1999. Examples:
  2000. cm ^lock ^list
  2001. cm ^lock ^list --^server=myserver:8084
  2002. cm ^lock ^ls ^serverpath:/src/foo.c#^cs:99@default@localhost:8084
  2003. cm ^lock ^list ^revid:3521@default ^itemid:2381@secondary --^onlycurrentuser
  2004. cm ^lock ^ls --^onlycurrentuser
  2005. cm ^lock ^ls --^onlycurrentuser --^onlycurrentworkspace
  2006. cm ^lock ^list --^machinereadable --^startlineseparator=">" \
  2007. --^endlineseparator="<" --^fieldseparator=","
  2008. == CMD_DESCRIPTION_LISTUSERS ==
  2009. Lists users and groups.
  2010. == CMD_USAGE_LISTUSERS ==
  2011. Usage:
  2012. cm ^listusers | ^lu <repserverspec> [--^onlyusers] [--^onlygroups]
  2013. [--^filter=<str_filter>]
  2014. cm ^listusers | ^lu <repserverspec> --^group=<group_name>
  2015. repserverspec Repository server specification.
  2016. (Use 'cm ^help ^objectspec' to learn more about specs.)
  2017. Options:
  2018. --^onlyusers Lists only users.
  2019. --^onlygroups Lists only groups.
  2020. --^filter Lists only users and/or groups that matches the
  2021. specified filter.
  2022. --^group Lists only users from a certain group. This option is
  2023. not compatible with ^onlyusers, ^onlygroups, nor ^filter.
  2024. == CMD_HELP_LISTUSERS ==
  2025. Examples:
  2026. cm ^lu localhost:8084
  2027. (Lists all users in the server.)
  2028. cm ^listusers localhost:8084 --^onlyusers --^filter=m
  2029. (Lists only the users in the server that contains "m".)
  2030. cm ^listusers codice@cloud --^group=Administrators
  2031. (Lists only the users in the group Administrators in the 'codice@cloud' org.)
  2032. == CMD_DESCRIPTION_LOCATION ==
  2033. Returns the path of 'cm'.
  2034. == CMD_USAGE_LOCATION ==
  2035. Usage:
  2036. cm ^location
  2037. == CMD_HELP_LOCATION ==
  2038. == CMD_DESCRIPTION_LOCK ==
  2039. This command allows the user to manage locks.
  2040. == CMD_USAGE_LOCK ==
  2041. Usage:
  2042. cm ^lock <command> [options]
  2043. Commands:
  2044. ^list | ^ls
  2045. ^unlock
  2046. To get more information about each command run:
  2047. cm ^lock <command> --^usage
  2048. cm ^lock <command> --^help
  2049. == CMD_HELP_LOCK ==
  2050. Examples:
  2051. cm ^lock ^list
  2052. cm ^lock
  2053. (The option '^list' is optional if there are no arguments.)
  2054. cm ^lock ^ls ^serverpath:/src/foo.c#^cs:99@default@localhost:8084
  2055. cm ^lock ^unlock 91961b14-3dfe-4062-8c4c-f33a81d201f5
  2056. == CMD_DESCRIPTION_LOG ==
  2057. Gets info about revisions in changesets.
  2058. == CMD_USAGE_LOG ==
  2059. Usage:
  2060. cm ^log [<csetspec> | <repspec>] [--^from=<csetspec_from>] [--^allbranches]
  2061. [--^ancestors] [--^csformat=<str_format>] [--^itemformat=<str_format>]
  2062. [--^xml[=<output_file>]] [--^encoding=<name>]
  2063. [--^repositorypaths | --^fullpaths | --^fp]
  2064. Options:
  2065. csetspec Returns all changes made in the specified changeset.
  2066. (Use 'cm ^help ^objectspec' to learn more about changeset
  2067. specs.)
  2068. repspec Returns all changes made in the specified repository.
  2069. (Use 'cm ^help ^objectspec' to learn more about repository
  2070. specs.)
  2071. --^from Lists all the changes made in every changeset from the
  2072. changeset specification [csetspec_from] to the
  2073. changeset specification [csetspec].
  2074. The [csetspec_from] changeset is not included in the
  2075. output.
  2076. Ignored when a repository spec is provided.
  2077. --^allbranches Shows information about the changesets created in a
  2078. specified interval, for all the branches where those
  2079. changesets were created.
  2080. --^ancestors Shows information about the reachable changesets by
  2081. following the parent and merge links for the given
  2082. changeset ([csetspec]). If the from changeset
  2083. ([csetspec_from]) is provided too, it will be used as
  2084. lower limit for all the paths. Remarks: The changeset
  2085. changes will not be shown when this option is used.
  2086. --^csformat Retrieves the changeset info in a specific format. See
  2087. Remarks for more info. This option cannot be combined
  2088. with '--^xml'.
  2089. --^itemformat Retrieves the item info in a specific format. See
  2090. Remarks for more info. This option cannot be combined
  2091. with '--^xml'.
  2092. --^xml Prints the output in XML format to the standard output.
  2093. It is possible to specify an output file. This option
  2094. cannot be combined with '--^csformat' and '--^itemformat'.
  2095. --^encoding Used with the '--^xml' option, specifies the encoding to
  2096. use in the XML output, i.e.: utf-8.
  2097. See the MSDN documentation at
  2098. http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx
  2099. to get the table of supported encodings and its format,
  2100. (at the end of the page, in the "Name" column).
  2101. --^fullpaths, --^fp Force printing full workspace paths for files and
  2102. directories when possible.
  2103. --^repositorypaths Prints repository paths (server paths) instead of
  2104. workspace paths. (This option overrides the
  2105. '--^fullpaths' option).
  2106. == CMD_HELP_LOG ==
  2107. Remarks:
  2108. - If neither 'csetspec' nor option is specified, the command shows
  2109. information about every changeset created within the last month in every
  2110. branch.
  2111. - If only the option '--^from' is included, the command shows the
  2112. information about every changeset from that specified changeset to the
  2113. last changeset in the branch where the changeset was created.
  2114. - If the option '--^allbranches' appears without an interval, the command
  2115. retrieves the same information as it would do if only 'csetspec' was
  2116. specified.
  2117. - If the '--^from' is used, the output contains information from the
  2118. 'csetspec_from'+1 on.
  2119. - The repository used to show the changeset information is the one loaded
  2120. in the path where the command executes on.
  2121. This command accepts a format string for the items ('--^itemformat') and a
  2122. format string for the changesets ('--^csformat').
  2123. The output parameters of '--^csformat' are the following:
  2124. {^tab} Inserts a tab space.
  2125. {^newline} Inserts a new line.
  2126. {^changesetid} Changeset number.
  2127. {^branch} Branch where the changeset was created.
  2128. {^date} Date of the changeset.
  2129. {^owner} Owner of the changeset.
  2130. {^comment} Comment of the changeset.
  2131. {^items} Items involved in the changeset.
  2132. {^repository} Repository where the changeset exists.
  2133. {^repserver} Server name.
  2134. The output parameters of '--^itemformat' are the following:
  2135. {^tab} Inserts a tab space.
  2136. {^newline} Inserts a new line.
  2137. {^path} Item path.
  2138. {^branch} Branch where the changeset was created.
  2139. {^date} Date of the changeset.
  2140. {^owner} Owner of the changeset.
  2141. {^shortstatus} Prints the short format for the status. See below.
  2142. {^fullstatus} Prints the long format for the status. See below.
  2143. Short format and its corresponding long format:
  2144. '^A' ^Added
  2145. '^D' ^Deleted
  2146. '^M' ^Moved
  2147. '^C' ^Changed
  2148. These are valid output strings:
  2149. --^csformat="{^newline}Changeset {^changesetid} created on {^date};{^tab} changed items: {^items}."
  2150. --^itemformat="{^newline}The item {^path} was changed in the branch {^branch}."
  2151. Examples:
  2152. cm ^log
  2153. (Shows information about every changeset created in the last month in every
  2154. branch.)
  2155. cm ^log ^cs:16
  2156. (Shows information about the changes done in the changeset 16 in the branch
  2157. where the changeset was created.)
  2158. cm ^log ^cs:16 --^csformat="{^newline}Changeset {^changesetid} created on \
  2159. {^date};{^tab} changed items: {^items}."
  2160. (Shows the information in the specified format.)
  2161. cm ^log --^from=^cs:20 ^cs:50
  2162. (Shows the information about every revision contained in every changeset
  2163. from the changeset 21 to the changeset 50.)
  2164. cm ^log --^from=^cs:20 ^cs:50 --^allbranches
  2165. (Shows the information about every revision contained in every changeset
  2166. from the changeset 21 to the changeset 50 in every branch of the
  2167. repository.)
  2168. cm ^log ^rep:myrep@localhost:8084
  2169. (Shows information about the changes done in the specified repository.
  2170. No workspace is required to run the command.)
  2171. cm ^log --^from=^cs:20@^rep:mainRep@localhost:8084
  2172. (Shows the information about every revision contained in every changeset
  2173. from the changeset 21. No workspace is required to run the command, because
  2174. the full changeset spec was specified.)
  2175. == CMD_DESCRIPTION_LS ==
  2176. Lists the contents of a tree.
  2177. == CMD_USAGE_LS ==
  2178. Usage:
  2179. cm ^ls | ^dir [<paths>[ ...]] [--^format=<str_format>] [--^symlink]
  2180. [--^selector[=<selector_format>]] [--^tree=<obj_spec>]
  2181. [-^R | -^r | --^recursive]
  2182. [--^xml[=<output_file>]] [--^encoding=<name>]
  2183. Options:
  2184. paths List of paths to show. Use a whitespace to separate
  2185. paths.
  2186. Use double quotes (" ") to specify paths containing
  2187. spaces.
  2188. --^format Retrieves the output message in a specific format. See
  2189. Remarks for more info. This option cannot be combined
  2190. with '--^xml'.
  2191. --^symlink Applies the operation to the symlink and not to the
  2192. target.
  2193. --^selector Gets the content from the active workspace selector.
  2194. If selector_format is specified, then lists the
  2195. specified selector.
  2196. This is mostly deprecated since selectors are
  2197. no longer a central part of Plastic SCM since 4.x.
  2198. --^tree Lists the tree in the specified changeset or branch.
  2199. (Use 'cm ^help ^objectspec' to learn more about specs.)
  2200. -^R Lists recursively.
  2201. --^xml Prints the output in XML format to the standard output.
  2202. It is possible to specify an output file. This option
  2203. cannot be combined with '--^format'.
  2204. --^encoding Used with the '--^xml' option, specifies the encoding to
  2205. use in the XML output, i.e.: utf-8.
  2206. See the MSDN documentation at
  2207. http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx
  2208. to get the table of supported encodings and its format,
  2209. (at the end of the page, in the "Name" column).
  2210. == CMD_HELP_LS ==
  2211. Remarks:
  2212. - Path can be typed with meta-characters.
  2213. - The list depends on the workspace selector.
  2214. - The output of the command can be formatted specifying a format string.
  2215. - If '--^tree' or '--^selector' options are specified, the given
  2216. path must be a server path (a.k.a.: 'cm path'): /dir/file.txt, not a
  2217. workspace path: C:\Users\myuser\mywk\dir\file.txt
  2218. - If no path is provided, the workspace path assumed is the current
  2219. directory. If '--^tree' or '--^selector' options are used, then
  2220. the root path ("/") is assumed.
  2221. The default format string is:
  2222. "{^size,10} {^date:dd/MM/yyyy} {^date:HH:mm}\
  2223. {^type,-6} {^location,-12} {^checkout,-5} {^name}\
  2224. {^symlinktarget}"
  2225. Output format parameters (--^format option):
  2226. This command accepts a format string to show the output.
  2227. The output parameters of this command are the following:
  2228. {^size}
  2229. {^formattedsize}
  2230. {^date}
  2231. {^type}
  2232. ^dir directory,
  2233. ^txt text file,
  2234. ^File file.
  2235. {^location} Example: ^br:branch#cset
  2236. {^checkout}
  2237. {^name}
  2238. {^changeset}
  2239. {^path}
  2240. {^repspec}
  2241. {^owner}
  2242. {^revid}
  2243. {^parentrevid}
  2244. {^itemid}
  2245. {^brid}
  2246. {^repid}
  2247. {^server}
  2248. {^symlinktarget}
  2249. {^hash}
  2250. {^chmod}
  2251. {^wkpath} Path relative to workspace root
  2252. {^branch}
  2253. {^newlocation} cset@branch
  2254. {^guid} (Will take longer to resolve)
  2255. {^itemguid}
  2256. {^transformed} Show applied rule for transformed items. Check the
  2257. Administrator Guide to learn about Transformable workspaces:
  2258. https://www.plasticscm.com/download/help/adminguide
  2259. You can customize the '^ls' format setting the PLASTIC_LS_FORMAT environment
  2260. variable.
  2261. Examples:
  2262. cm ^ls
  2263. cm ^ls c:\workspace\src
  2264. cm ^ls --^format={^name}
  2265. (Only file names.)
  2266. cm ^ls --^symlink
  2267. (Displays information about the symlink instead of the target file or
  2268. directory.)
  2269. cm ^ls code --^selector
  2270. (Shows the content of the 'code' subdirectory from the current workspace
  2271. selector.)
  2272. cm ^ls /code --^selector="^rep 'myrep' ^path '/' ^branch '/^main'"
  2273. (Shows the content of the '/code' subdirectory on the specified selector.
  2274. Note that the path is specified in server format.)
  2275. cm ^ls /code --^tree=44@myrep@denver:7070
  2276. (Lists the '/code' subdirectory at changeset 44 at repo 'myrep' at server
  2277. 'denver:7070'.)
  2278. cm ^ls /code --^tree=^br:/main/scm13596@myrep@denver:7070
  2279. (Lists the '/code' subdirectory at the latest changeset in branch
  2280. '/main/scm13596' at repo 'myrep' at server 'denver:7070'.)
  2281. cm ^ls /code --^tree=ae1390ed-7ce9-4ec3-a155-e5a61de0dc77@myrep@denver:7070
  2282. (Lists the '/code' subdirectory at changeset
  2283. ae1390ed-7ce9-4ec3-a155-e5a61de0dc77 at repo 'myrep' at server
  2284. 'denver:7070'.)
  2285. == CMD_DESCRIPTION_TRIGGER_LIST ==
  2286. Lists the triggers of a given type on a server.
  2287. == CMD_USAGE_TRIGGER_LIST ==
  2288. Usage:
  2289. cm ^trigger | ^tr ^list | ^ls [<subtype-type>] [--^server=<repserverspec>]
  2290. [--^format=<str_format>]
  2291. Options:
  2292. subtype-type Trigger execution and trigger operation.
  2293. (Use 'cm ^showtriggertypes' to see a list of trigger
  2294. types.)
  2295. --^server Lists the triggers on the specified server.
  2296. If no server is specified, executes the command on the
  2297. one configured on the client.
  2298. (Use 'cm ^help ^objectspec' to learn more about server
  2299. specs.)
  2300. --^format Retrieves the output message in a specific format. See
  2301. Remarks for more info.
  2302. == CMD_HELP_TRIGGER_LIST ==
  2303. Remarks:
  2304. If the type is not specified, lists all the triggers on the server.
  2305. Output format parameters (--^format option):
  2306. This command accepts a format string to show the output.
  2307. The output parameters of this command are the following:
  2308. {0} Trigger position.
  2309. {1} Trigger name.
  2310. {2} Trigger path.
  2311. {3} Trigger owner.
  2312. {4} Trigger type.
  2313. {5} Trigger filter.
  2314. Examples:
  2315. cm ^trigger list after-mklabel
  2316. (Lists all triggers of type 'after-mklabel' on the server configured on the
  2317. client.)
  2318. cm ^tr ^ls ^before-mkbranch --^server=myserver:8084
  2319. (Lists all triggers of type 'before-mkbranch' on server 'myserver:8084'.)
  2320. == CMD_DESCRIPTION_MANIPULATESELECTOR ==
  2321. Changes the selector to a date.
  2322. == CMD_USAGE_MANIPULATESELECTOR ==
  2323. This is an automation command, meant to be used to automate 'cm' only.
  2324. It is not as user friendly as it should be.
  2325. Usage:
  2326. cm ^manipulateselector | ^ms [<wk_path> | <wk_spec>] --^atdate=<sel_date>
  2327. wk_path Path of the workspace.
  2328. wk_spec Workspace specification. (Use 'cm ^help ^objectspec' to
  2329. learn more about specs.)
  2330. Options:
  2331. --^atdate Returns a selector that will recreate the workspace as
  2332. it would have looked at the specified date.
  2333. == CMD_HELP_MANIPULATESELECTOR ==
  2334. Remarks:
  2335. If neither path nor workspace spec is specified, the command will take the
  2336. current directory as workspace path.
  2337. Examples:
  2338. cm ^manipulateselector c:\workspace --^atdate=yyyy-MM-ddTHH:mm:ss
  2339. cm ^manipulateselector --^atdate=yyyy-MM-ddTHH:mm:ss
  2340. cm ^manipulateselector > mySelector.txt --^atdate=yyyy-MM-ddTHH:mm:ss
  2341. cm ^manipulateselector ^wk:build_wk@BUILDER --^atdate=yyyy-MM-ddTHH:mm:ss
  2342. == CMD_DESCRIPTION_MERGE ==
  2343. Merges a branch with another branch.
  2344. == CMD_USAGE_MERGE ==
  2345. Usage:
  2346. cm ^merge <source_spec> [--^merge] [--^cherrypicking] [--^forced]
  2347. [--^mergetype=(^onlyone|^onlysrc|^onlydst|^try|^forced)]
  2348. [--^interval-origin=<csetspec> | --^ancestor=<csetspec>]
  2349. [--^keepsource | --^ks] [--^keepdestination | --^kd]
  2350. [--^automaticresolution=<conflict-types>[;...]]
  2351. [--^subtractive] [--^mount] [--^printcontributors]
  2352. [--^noprintoperations] [--^silent]
  2353. [(--^to=<brspec> | --^destination=<brspec>)[--^shelve]]
  2354. [--^no-dst-changes]
  2355. [-^c=<str_comment> | --^commentsfile=<comments_file>]
  2356. [--^resolveconflict --^conflict=<index>
  2357. --^resolutionoption=(^src|^dst|(^rename --^resolutioninfo=<strname>))
  2358. --^mergeresultfile=<path> --^solvedconflictsfile=<path>]
  2359. [--^nointeractiveresolution]
  2360. [--^machinereadable [--^startlineseparator=<sep>]
  2361. [--^endlineseparator=<sep>] [--^fieldseparator=<sep>]]
  2362. source_spec Specification of the source object to merge from:
  2363. - a branch specification: '[^br:/]br_name'
  2364. - a label specification: '^lb:lb_name'
  2365. - a changeset specification: '^cs:cs_number'
  2366. - a shelve specification: '^sh:shelve_number'
  2367. (Use 'cm ^help ^objectspec' to learn more about specs.)
  2368. Options:
  2369. --^merge Performs the merge. Otherwise, prints the
  2370. conflicts found.
  2371. --^cherrypicking Merges the changes included on the source
  2372. changesets. This option is not used if the merge
  2373. source specification is a label.
  2374. --^forced Does not check if the source and destination are
  2375. already connected.
  2376. This option is only available for interval merge
  2377. and cherry picking.
  2378. --^mergetype Type of the merge. See Remarks for more info.
  2379. --^interval-origin Specifies which changeset is chosen as the
  2380. interval origin, so the merge will only take the
  2381. differences between the source changeset and the
  2382. specified interval origin.
  2383. --^ancestor This is an alias of '--^interval-origin'.
  2384. --^keepsource Accepts all changes from source contributor for
  2385. items with conflicts.
  2386. --^keepdestination Preserves changes from destination contributor
  2387. for items with conflicts.
  2388. --^automaticresolution Used to resolve directory conflicts. This option
  2389. lets you choose whether the source or the
  2390. destination contributor should be automatically
  2391. selected to resolve the conflict.
  2392. Use a semicolon to separate conflict types.
  2393. See Remarks for more info.
  2394. --^subtractive Deletes changes introduced by a merge. The
  2395. parameter passed to the command (source_spec) is
  2396. used to specify which is the source to delete
  2397. changes. It must be a changeset. In the case of a
  2398. changeset interval, the '--^interval-origin' must
  2399. be used to define the interval origin. To remove
  2400. a change, the system creates a new checked out
  2401. revision which will have the content of the
  2402. previous one except for the deleted changes.
  2403. --^mount The mount point for the given repository.
  2404. --^printcontributors Prints the contributors (base, source, and
  2405. destination).
  2406. --^noprintoperations Silently resolves merges without showing
  2407. information about the resolution.
  2408. --^silent Does not show any output.
  2409. --^to | --^destination Performs a merge-to operation to the specified
  2410. branch (by entering a branch spec or brspec)
  2411. with full conflict resolution.
  2412. (Use 'cm ^help ^objectspec' to learn more about
  2413. branch specs.)
  2414. A "merge-to" (or workspace-less merge) is a merge
  2415. done in the server side. While normal merges
  2416. happen on a workspace merging "from" a branch,
  2417. label or changeset, a merge-to happens entirely
  2418. on the server. While in normal merges the
  2419. "destination" is the workspace, in "merge-to" a
  2420. destination must be always specified (that's why
  2421. we call it "to").
  2422. Check the following link for more information
  2423. about the "merge to" feature:
  2424. https://www.plasticscm.com/download/help/mergeto
  2425. --^shelve Creates a shelve with the changes of the merge
  2426. result (plus merge traceability info) instead of
  2427. creating a new changeset. This option is not
  2428. available when the merge source is a shelve. This
  2429. option is only available for server-side-merge
  2430. (a.k.a. "merge-to"). Hence, the '--^to' and
  2431. '--^merge' options are required.
  2432. --^no-dst-changes Ensures that the destination contributor doesn't
  2433. have changes (the destination changeset is also
  2434. the common ancestor). When there are changes on
  2435. the destination, the merge is not allowed.
  2436. -^c Applies the specified comment to the changeset
  2437. created in the merge operation.
  2438. --^commentsfile Applies the comment in the specified file to the
  2439. changeset created in the merge operation.
  2440. --^resolveconflict (Mainly used by plugins. See Remarks for more info.)
  2441. Used to solve a directory conflict.
  2442. --^conflict Used with the '--^resolveconflict' flag, specifies
  2443. the index of the conflict to solve starting at 1.
  2444. --^resolutionoption Used with the '--^resolveconflict' flag, indicates
  2445. the type of the conflict resolution. Use one of
  2446. the following options: '^src', '^dst', '^rename'.
  2447. See Remarks for more info.
  2448. --^resolutioninfo Used with the '--^resolveconflict' flag, provides
  2449. the name to use when the '--^resolutionoption'
  2450. option is 'rename'.
  2451. --^mergeresultfile Used with the '--^resolveconflict' flag, outputs
  2452. into a file the information of the merge result
  2453. between different calls .The specified path will
  2454. be created during the first call and updated on
  2455. each next call.
  2456. --^solvedconflictsfile Used with the '--^resolveconflict' flag, outputs
  2457. into a file the information of the conflicts
  2458. solved between different calls. The specified
  2459. path will be created during the first call and
  2460. updated on each next call.
  2461. --^nointeractiveresolution (Mainly used by plugins. See Remarks for more info.)
  2462. Avoids prompting the user for manual conflict.
  2463. This way, a directory conflict won't be solved.
  2464. --^machinereadable (Mainly used by plugins. See Remarks for more info.)
  2465. Outputs the result in an easy-to-parse format.
  2466. --^startlineseparator Used with the '--^machinereadable' flag, specifies
  2467. how the lines should start. (Default: empty string.)
  2468. --^endlineseparator Used with the '--^machinereadable' flag, specifies
  2469. how the lines should end. (Default: empty string.)
  2470. --^fieldseparator Used with the '--^machinereadable' flag, specifies
  2471. how the fields should be separated. (Default:
  2472. whitespace.)
  2473. == CMD_HELP_MERGE ==
  2474. Remarks:
  2475. This command is used to merge changes between two branches or between a
  2476. label and a branch. The destination of the merge must be always a branch.
  2477. The merge source is specified as an argument.
  2478. Destination is the current content of the workspace.
  2479. For example, to display the elements that will be merged from branch
  2480. task001 to the main branch, the selector must point to the main branch,
  2481. the workspace must be updated, and then:
  2482. cm ^merge ^br:/task001
  2483. To really perform the merge, '--^merge' option is added:
  2484. cm ^merge ^br:/task001 --^merge
  2485. To define the merge source, the following specs can be used:
  2486. - A branch specification (brspec):
  2487. [^br:/]br_name
  2488. Example: ^br:/main/task001
  2489. (Merges from the last changeset on this branch.)
  2490. - A label specification (lbspec):
  2491. ^lb:lb_name
  2492. Example: ^lb:BL001
  2493. (Merges from the labeled changeset.)
  2494. - A changeset specification (csetspec):
  2495. ^cs:cs_number
  2496. Example: ^cs:25
  2497. (Merges from the given changeset content.)
  2498. - A shelve specification (shspec):
  2499. ^sh:shelve_number
  2500. Example: ^sh:2
  2501. (Merges from the given shelve content.)
  2502. To automatically resolve directory conflicts, use '--^automaticresolution'
  2503. option and specify the type of conflict followed by the contributor
  2504. (source or destination) that must be selected during the merge operation.
  2505. (Separate each "type of conflict"-"contributor" pair by a semicolon (;).)
  2506. For example:
  2507. cm ^merge ^cs:2634 --^merge --^automaticresolution=^eviltwin-src;^changedelete-src
  2508. (The merge operation from changeset 2634 resolves the "^eviltwin" and
  2509. "^changedelete" conflicts by keeping the source ("-^src") contributor in
  2510. both cases.)
  2511. - A "-^src" suffix after a conflict type tells the merge command to keep the
  2512. source contributor changes.
  2513. - A "-^dst" suffix will keep the destination contributor changes.
  2514. This is the list of conflict types the merge command supports:
  2515. "^movedeviltwin", "^eviltwin", "^changedelete", "^deletechange", "^movedelete",
  2516. "^deletemove", "^loadedtwice", "^addmove", "^moveadd", "^divergentmove",
  2517. "^cyclemove", "^all".
  2518. The "^all" value overrides the other options. In the following example,
  2519. "^eviltwin-dst" will be ignored:
  2520. cm ^merge ^br:/main/task062 --^merge --^automaticresolution=^all-src;^eviltwin-dst
  2521. Check the following link to learn more about merge conflicts:
  2522. https://www.plasticscm.com/download/help/directorymerges
  2523. These are the options for '--^mergetype':
  2524. ^onlyone Automatic merge if only one contributor modified the
  2525. item.
  2526. ^onlysrc Automatic merge if only source contributor modified the
  2527. item.
  2528. ^onlydst Automatic merge if only destination contributor modified
  2529. the item.
  2530. ^try Automatic merge if only one contributor has modified the
  2531. conflictive piece of code (each conflict).
  2532. ^forced Always try to solve all non-automatic conflicts.
  2533. These are the options that are mainly used by plugins and integrations:
  2534. - '--^resolveconflict' to solve a directory conflict. You also have to
  2535. use the following options:
  2536. - '--^conflict' is the index of the conflict that you want to
  2537. solve, starting at 1.
  2538. - '--^resolutionoption' indicates the conflict resolution to
  2539. use. This can be:
  2540. - '^src' to keep the source change and discard the
  2541. destination change
  2542. - '^dst' to keep the destination change and discard the
  2543. source change
  2544. - '^rename' (only if the conflict type supports this
  2545. resolution), to rename the destination to the given name
  2546. provided with the '--^resolutioninfo' option.
  2547. - '--^resolutioninfo' to provide the name to use on a
  2548. '^rename' resolution
  2549. - '--^mergeresultfile' and '--^solvedconflictsfile', both used to
  2550. store the merge info between different calls.
  2551. - '--^nointeractiveresolution' indicates the merge to not ask the user for
  2552. manual conflict resolution.
  2553. - '--^machinereadable' and '--^startlineseparator', '--^endlineseparator',
  2554. '--^fieldseparator' options to print the output on a machine-readable
  2555. way (easier-to-parse).
  2556. Example:
  2557. cm ^merge --^machinereadable --^startlineseparator=start@_@line \
  2558. --^endlineseparator=new@_@line --^fieldseparator=def#_#sep \
  2559. --^mergeresultfile=C:\Users\Borja\AppData\Local\Temp\2tmp4D6C.tmp \
  2560. --^solvedconflictsfile=C:\Users\Borja\AppData\Local\Temp\2tmp4D6D.tmp \
  2561. --^resolveconflict --^conflict=1 --^resolutionoption=rename \
  2562. --^resolutioninfo=bin_dst ^br:/main/task --^merge
  2563. Set the PLASTICEDITOR environment variable to specify an editor for
  2564. entering comments. If the PLASTICEDITOR environment variable is set, and
  2565. the comment is empty, the editor will be automatically launched to allow
  2566. you to specify the comment.
  2567. Examples:
  2568. cm ^merge ^br:/task001
  2569. (Does not merge, just prints items to be merged.)
  2570. cm ^merge ^br:/task001 --^merge
  2571. (Does merge from branch 'task001'.)
  2572. cm ^merge ^cs:5 --^merge --^cherrypicking --^interval-origin=^cs:2
  2573. (Cherry pick from the changeset interval (2,5].)
  2574. cm ^merge ^cs:8 --^merge --^subtractive --^keepdestination
  2575. (Subtractive merge from changeset 8, keeping destination changes for those
  2576. elements with conflicts.)
  2577. cm ^merge ^br:/main/task001 --^to=^br:/main --^merge -^c="Integrated new UI"
  2578. (Does server-side merge, a.k.a. merge-to, from branch 'task001' to branch
  2579. 'main' and sets a comment.)
  2580. cm ^merge ^br:/main/task001 --^to=^br:/main --^merge --^shelve
  2581. (Does server-side merge from branch 'task001' to branch 'main' and leaves
  2582. the result on a shelve.)
  2583. cm ^merge ^sh:2 --^to=^br:/main --^merge --^no-dst-changes
  2584. (Applies the shelve 2 into 'main' only if it was created from the current
  2585. 'main' head')
  2586. == CMD_DESCRIPTION_ATTRIBUTE_CREATE ==
  2587. Creates a new attribute.
  2588. == CMD_USAGE_ATTRIBUTE_CREATE ==
  2589. Usage:
  2590. cm ^attribute | ^att ^create | ^mk <att_name>
  2591. att_name Attribute name
  2592. == CMD_HELP_ATTRIBUTE_CREATE ==
  2593. Remarks:
  2594. Set the PLASTICEDITOR environment variable to specify an editor for
  2595. entering comments. If the PLASTICEDITOR environment variable is set, and
  2596. the comment is empty, the editor will be automatically launched to allow
  2597. you to specify the comment.
  2598. Examples:
  2599. cm ^attribute ^create status
  2600. (Creates the attribute 'status'.)
  2601. cm ^att ^mk integrated
  2602. (Creates the attribute 'integrated'.)
  2603. == CMD_DESCRIPTION_BRANCH ==
  2604. Allows the user to manage branches.
  2605. == CMD_USAGE_BRANCH ==
  2606. Usage:
  2607. cm ^branch | ^br <command> [options]
  2608. Commands:
  2609. ^create | ^mk
  2610. ^delete | ^rm
  2611. ^rename
  2612. ^history
  2613. ^showmain
  2614. ^showmerges
  2615. To get more information about each command run:
  2616. cm ^branch <command> --^usage
  2617. cm ^branch <command> --^help
  2618. == CMD_HELP_BRANCH ==
  2619. Examples:
  2620. cm ^branch /main/scm21345
  2621. cm ^branch ^create /main/scm21345
  2622. cm ^branch ^delete /main/scm21345
  2623. cm ^branch ^rename /main/scm21345 scm21346
  2624. cm ^branch ^history /main/scm21345
  2625. cm ^branch ^showmain
  2626. cm ^branch ^showmerges file.txt
  2627. == CMD_DESCRIPTION_BRANCH_CREATE ==
  2628. Creates a new branch.
  2629. == CMD_USAGE_BRANCH_CREATE ==
  2630. Usage:
  2631. cm ^branch | ^br [^create | ^mk] <brspec>
  2632. [--^changeset=<csetspec> | --^label=<lbspec>]
  2633. [-^c=<str_comment> | -^commentsfile=<comments_file>]
  2634. brspec The new branch name or spec.
  2635. (Use 'cm ^help ^objectspec' to learn more about branch specs.)
  2636. Options:
  2637. --^changeset Changeset used as starting point for the new branch.
  2638. (Use 'cm ^help ^objectspec' to learn more about cset specs.)
  2639. --^label Label used as starting point for the new branch.
  2640. (Use 'cm ^help ^objectspec' to learn more about label specs.)
  2641. -^c Fills in the comment field of the new branch with the
  2642. specified text.
  2643. -^commentsfile Fills in the comment field of the new branch with the
  2644. contents of the specified file.
  2645. == CMD_HELP_BRANCH_CREATE ==
  2646. Remarks:
  2647. To create a top-level branch, specify the name without any hierarchy.
  2648. For example:
  2649. cm ^br /dev
  2650. If no optional parameter '--^changeset' is specified, the base of the new
  2651. branch will be the last changeset on the parent branch. If the new branch
  2652. is a top-level branch, the base changeset used will be cset 0.
  2653. You can specify a comment using either the '-^c' or the '-^m' switches:
  2654. cm ^branch /main/task001 -^c="This is the comment"
  2655. cm ^branch /main/task001 -^m "This is the comment"
  2656. Set the PLASTICEDITOR environment variable to specify an editor for
  2657. entering comments. If the PLASTICEDITOR environment variable is set, and
  2658. the comment is empty, the editor will be automatically launched to allow
  2659. you to specify the comment.
  2660. Examples:
  2661. cm ^branch task001
  2662. cm ^branch ^create task001
  2663. cm ^branch ^mk task001
  2664. cm ^br ^mk task001
  2665. (All of the examples above, create a top-level 'task001' branch in the
  2666. repository of the current workspace.)
  2667. cm ^branch ^br:/task001/task002@
  2668. (Creates 'task002' branch as child of 'task001'.)
  2669. cm ^br /main/task001@myrep@myserver:8084 -^c="my comment"
  2670. (Creates 'task001' branch as child of 'main' in repository
  2671. 'myrep@myserver:8084' with comment 'my comment'.)
  2672. cm ^branch ^br:/main/task001 --^changeset=2837 -^commentsfile=commenttask001.txt
  2673. (Creates the 'task001' branch as child of 'main' with base 'changeset=2837',
  2674. and applies the comment in 'commenttask001.txt' file.)
  2675. == CMD_DESCRIPTION_BRANCH_DELETE ==
  2676. Deletes one or more branches.
  2677. == CMD_USAGE_BRANCH_DELETE ==
  2678. Usage:
  2679. cm ^branch | ^br ^delete | ^rm <brspec>[ ...]
  2680. brspec Branch to delete. Use a whitespace to separate branches.
  2681. (Use 'cm ^help ^objectspec' to learn more about branch
  2682. specs.)
  2683. == CMD_HELP_BRANCH_DELETE ==
  2684. Remarks:
  2685. This command deletes one or more branches.
  2686. Examples:
  2687. cm ^branch ^delete /main/task001
  2688. (Deletes the branch with name 'task001' that is a child of 'main' in the
  2689. repository of the current workspace.)
  2690. cm ^br ^rm main/task002 /main/task012@reptest@myserver:8084
  2691. (Deletes branches '/main/task002' in the repository of the current workspace
  2692. and '/main/task012' in the repository 'reptest@myserver:8084'.)
  2693. == CMD_DESCRIPTION_BRANCH_RENAME ==
  2694. Renames a branch.
  2695. == CMD_USAGE_BRANCH_RENAME ==
  2696. Usage:
  2697. cm ^branch | ^br ^rename <brspec> <new_name>
  2698. brspec Branch to rename.
  2699. (Use 'cm ^help ^objectspec' to learn more about branch specs.)
  2700. new_name New name for the branch.
  2701. == CMD_HELP_BRANCH_RENAME ==
  2702. Remarks:
  2703. This command renames a branch.
  2704. Examples:
  2705. cm ^branch ^rename /main/task0 task1
  2706. (Renames branch '/main/task0' to '/main/task1'.)
  2707. cm ^br ^rename ^br:/main@reptest@server2:8084 secondary
  2708. (Renames the 'main' branch of repository 'reptest' to 'secondary'.)
  2709. == CMD_DESCRIPTION_BRANCH_HISTORY ==
  2710. Shows the history of a branch.
  2711. == CMD_USAGE_BRANCH_HISTORY ==
  2712. Usage:
  2713. cm ^branch | ^br ^history <brspec> [--^dateformat=<date_format>]
  2714. [--^machinereadable]
  2715. brspec The branch specification to obtain the history.
  2716. (Use 'cm ^help ^objectspec' to learn more about branch specs.)
  2717. Options:
  2718. --^dateformat Format used to output dates.
  2719. --^machinereadable Outputs the result in an easy-to-parse format.
  2720. == CMD_HELP_BRANCH_HISTORY ==
  2721. Examples:
  2722. cm ^branch ^history ^br:/main/scm001@myrepository@myserver:8084
  2723. (Displays the history of '/main/scm001' branch of 'myrepository' repository
  2724. on 'myserver' server.)
  2725. cm ^br ^history main --^dateformat="yyyy, dd MMMM" --^machinereadable
  2726. (Displays the history of the 'main' branch of the current repository,
  2727. with a given date format, and in an easy-to-parse format.)
  2728. == CMD_DESCRIPTION_BRANCH_SHOWMAIN ==
  2729. Shows the main branch of a repository.
  2730. This is an automation command, meant to be used to automate 'cm' only.
  2731. Most likely, the main branch of your repository is '/main'.
  2732. == CMD_USAGE_BRANCH_SHOWMAIN ==
  2733. Usage:
  2734. cm ^branch | ^br ^showmain [<repspec>] [--^encoding=<name>]
  2735. [--^format=<format_str>] [--^dateformat=<date_format>]
  2736. repspec The repository specification where to show the main
  2737. branch. If no repspec is specified, the command will show
  2738. the main branch for the repository of the current
  2739. workspace.
  2740. (Use 'cm ^help ^objectspec' to learn more about rep specs.)
  2741. Options:
  2742. --^encoding Specifies the encoding to use in the output,
  2743. i.e.: utf-8.
  2744. See the MSDN documentation at
  2745. http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx
  2746. to get the table of supported encodings and its format,
  2747. (at the end of the page, in the "Name" column).
  2748. --^format Retrieves the output message in a specific format. See
  2749. Remarks for more info.
  2750. --^dateformat Format used to output dates.
  2751. == CMD_HELP_BRANCH_SHOWMAIN ==
  2752. Remarks:
  2753. This command shows the main branch of a repository.
  2754. Output format parameters (--^format option):
  2755. This command accepts a format string to show the output.
  2756. The output parameters of this command are the following:
  2757. {^id} Branch id.
  2758. {^comment} Comment.
  2759. {^date} Date.
  2760. {^name} Name.
  2761. {^owner} Owner.
  2762. {^parent} Parent branch name.
  2763. {^repository} Repository.
  2764. {^repname} Repository name.
  2765. {^repserver} Server.
  2766. {^changeset} Head changeset of the branch.
  2767. Examples:
  2768. cm ^branch ^showmain
  2769. (Displays the main branch for the repository of the current workspace.)
  2770. cm ^branch ^showmain repo@server:8084
  2771. (Displays the main branch for the repository 'repo' in server
  2772. 'server:8084'.)
  2773. cm ^br ^showmain --^dateformat="yyyy, dd MMMM" --^encoding=utf-8
  2774. (Displays the main branch of the repository with a given date format,
  2775. and the output is in utf-8.)
  2776. cm ^br ^showmain --^format="{^id} - {^name}"
  2777. (Displays the main branch of the repository, printing only its id and name.)
  2778. == CMD_DESCRIPTION_BRANCH_SHOWMERGES ==
  2779. Shows branches pending to be merged.
  2780. == CMD_USAGE_BRANCH_SHOWMERGES ==
  2781. This is an automation command, meant to be used to automate 'cm' only.
  2782. It is not as user friendly as it should be.
  2783. Usage:
  2784. cm ^branch | ^br ^showmerges <item_path>[ ...]
  2785. [--^format=<format_str>]
  2786. [--^dateformat=<date_format>]
  2787. Options:
  2788. --^format Retrieves the output message in a specific format. See
  2789. Remarks for more info.
  2790. --^dateformat Format used to output dates.
  2791. == CMD_HELP_BRANCH_SHOWMERGES ==
  2792. Remarks:
  2793. Output format parameters (--^format option):
  2794. This command accepts a format string to show the output.
  2795. The output parameters of this command are the following:
  2796. {^id} Branch id.
  2797. {^comment} Comment.
  2798. {^date} Date.
  2799. {^name} Name.
  2800. {^owner} Owner.
  2801. {^parent} Parent branch name.
  2802. {^parentid} Parent branch id.
  2803. {^repid} Repository id.
  2804. {^repository} Repository.
  2805. {^repname} Repository name.
  2806. {^repserver} Repository server.
  2807. Examples:
  2808. cm ^branch ^showmerges file.txt
  2809. (Displays branches involved in the pending merge of 'file.txt'.)
  2810. cm ^branch ^showmerges file.txt --^format="{^date} {^name}" --^dateformat="ddMMyy"
  2811. (Displays branches involved in the merge, printing only the date and the
  2812. name, with a given date format.)
  2813. == CMD_DESCRIPTION_REPOSITORY ==
  2814. Allows the user to manage repositories.
  2815. == CMD_USAGE_REPOSITORY ==
  2816. Usage:
  2817. cm ^repository | ^repo <command> [options]
  2818. Commands:
  2819. ^create | ^mk
  2820. ^delete | ^rm
  2821. ^list | ^ls
  2822. ^rename
  2823. ^add
  2824. To get more information about each command run:
  2825. cm ^repository <command> --^usage
  2826. cm ^repository <command> --^help
  2827. == CMD_HELP_REPOSITORY ==
  2828. Examples:
  2829. cm ^repository
  2830. cm ^repository ^list
  2831. cm ^repository newrepo
  2832. cm ^repository ^create newrepo
  2833. cm ^repository ^rename oldname newname
  2834. cm ^repository ^add C:\repo\
  2835. == CMD_DESCRIPTION_REPOSITORY_CREATE ==
  2836. Creates a repository on a server.
  2837. == CMD_USAGE_REPOSITORY_CREATE ==
  2838. Usage:
  2839. cm ^repository | ^repo <rep_name>
  2840. cm ^repository | ^repo <repserverspec> <rep_name>[ ...]
  2841. cm ^repository | ^repo [^create | ^mk] <rep_name>
  2842. repserverspec Repository server specification.
  2843. (Use 'cm ^help ^objectspec' to learn more about rep server
  2844. specs.)
  2845. rep_name Name or names of the new repository or repositories.
  2846. Use a whitespace to separate repository names.
  2847. == CMD_HELP_REPOSITORY_CREATE ==
  2848. Examples:
  2849. cm ^repository MyRep
  2850. cm ^repo 192.168.1.140:8087 Rep01 Rep01/ModuleA Rep01/ModuleB
  2851. cm ^repo ^create Rep01
  2852. cm ^repo ^mk list
  2853. == CMD_DESCRIPTION_REPOSITORY_DELETE ==
  2854. Deletes a repository from a server.
  2855. == CMD_USAGE_REPOSITORY_DELETE ==
  2856. Usage:
  2857. cm ^repository | ^repo ^delete | ^rm <repspec>
  2858. Options:
  2859. repspec Repository specification.
  2860. (Use 'cm ^help ^objectspec' to learn more about rep specs.)
  2861. == CMD_HELP_REPOSITORY_DELETE ==
  2862. Remarks:
  2863. Deletes a repository from the repository server.
  2864. The data is not removed from the database backend, but unplugged
  2865. so that it will not be accessible anymore.
  2866. (Data can be reconnected afterwards, see 'cm ^repository ^add'.)
  2867. Examples:
  2868. cm ^repository ^delete myrepository@^repserver:myserver:8084
  2869. cm ^repository ^rm myrepository@myserver:8084
  2870. cm ^repo ^rm myrepository
  2871. == CMD_DESCRIPTION_REPOSITORY_LIST ==
  2872. Lists the repositories on a server.
  2873. == CMD_USAGE_REPOSITORY_LIST ==
  2874. Usage:
  2875. cm ^repository | ^repo [^list | ^ls] [<repserverspec>] [--^format=<str_format>]
  2876. Options:
  2877. repserverspec Repository server specification.
  2878. (Use 'cm ^help ^objectspec' to learn more about rep server
  2879. specs.)
  2880. --^format Retrieves the output message in a specific format. See
  2881. Remarks for more info.
  2882. == CMD_HELP_REPOSITORY_LIST ==
  2883. Remarks:
  2884. Output format parameters (--^format option):
  2885. This command accepts a format string to show the output.
  2886. The output parameters of this command are the following:
  2887. {^repid} | {0} Repository identifier.
  2888. {^repname} | {1} Repository name.
  2889. {^repserver} | {2} Server name.
  2890. {^repowner} | {3} Repository owner.
  2891. {^repguid} | {4} Unique identifier of the repository.
  2892. {^tab} Inserts a tab space.
  2893. {^newline} Inserts a new line.
  2894. If the format parameter value is '^TABLE', the output will be printed
  2895. using a table format with the {^repid}, {^repname} and {^repserver} fields.
  2896. Examples:
  2897. cm ^repository
  2898. (Lists all repositories.)
  2899. cm ^repository ^list localhost:8084 --^format="{1, -20} {3}"
  2900. (Writes the repository name in 20 spaces, aligned to left, then a blank,
  2901. and then the repository owner.)
  2902. cm ^repository ^ls localhost:8084 --^format="{^repname, -20} {^repowner}"
  2903. (Writes the same as the previous example.)
  2904. cm ^repo ^ls localhost:8084 --^format=^TABLE
  2905. (Writes the list of repositories using a table format with the following
  2906. fields: repository id, repository name, and repository server name.)
  2907. == CMD_DESCRIPTION_REPOSITORY_RENAME ==
  2908. Renames a repository.
  2909. == CMD_USAGE_REPOSITORY_RENAME ==
  2910. Usage:
  2911. cm ^repository | ^repo ^rename [<repspec>] <new_name>
  2912. repspec Repository to be renamed.
  2913. (Use 'cm ^help ^objectspec' to learn more about repository
  2914. specifications.)
  2915. new_name New name for the repository.
  2916. == CMD_HELP_REPOSITORY_RENAME ==
  2917. Remarks:
  2918. This command renames a repository.
  2919. If no repspec is specified, current repository will be assumed.
  2920. Examples:
  2921. cm ^repository ^rename development
  2922. (The current repository will be renamed to 'development'.)
  2923. cm ^repo ^rename ^rep:default@SERVER:8084 development
  2924. (The 'default' repository on 'SERVER' will be renamed to 'development'.)
  2925. == CMD_DESCRIPTION_REPOSITORY_ADD ==
  2926. Connects an existing repository by adding its database.
  2927. == CMD_USAGE_REPOSITORY_ADD ==
  2928. Usage:
  2929. cm ^repository | ^repo ^add <db_file> <rep_name> <repserverspec>
  2930. db_file The name of the database file on the database backend.
  2931. rep_name The name of the repository.
  2932. repserverspec The repository server specification.
  2933. (Use 'cm ^help ^objectspec' to learn more about repository
  2934. server specifications.)
  2935. == CMD_HELP_REPOSITORY_ADD ==
  2936. Remarks:
  2937. Reconnects an existing repository database to the server. This command is
  2938. useful to move a repository from one server to another, or to restore an
  2939. archived repository after using the 'cm ^repository ^delete' command.
  2940. Examples:
  2941. cm ^repository ^add rep_27 myrepository myserver:8084
  2942. == CMD_DESCRIPTION_TRIGGER_CREATE ==
  2943. Creates a new trigger on a server.
  2944. == CMD_USAGE_TRIGGER_CREATE ==
  2945. Usage:
  2946. cm ^trigger | ^tr ^create | ^mk <subtype-type> <new_name> <script_path>
  2947. [--^position=<new_position>]
  2948. [--^filter=<str_filter>]
  2949. [--^server=<repserverspec>]
  2950. subtype-type Trigger execution and trigger operation.
  2951. (Use 'cm ^showtriggertypes' to see a list of trigger
  2952. types.)
  2953. new_name Name of the new trigger.
  2954. script_path Disk path on the server where the script to execute is
  2955. located. If the command line starts with "^webtrigger ",
  2956. the trigger will be considered as a web trigger. See
  2957. Remarks for more information.
  2958. Options:
  2959. --^position New position of the specified trigger.
  2960. This position must not be in use by another trigger of
  2961. the same type.
  2962. --^filter Checks only items that matches the specified filter.
  2963. --^server Creates the trigger on the specified server.
  2964. If no server is specified, executes the command on the
  2965. one configured on the client.
  2966. (Use 'cm ^help ^objectspec' to learn more about repository
  2967. server specifications.)
  2968. == CMD_HELP_TRIGGER_CREATE ==
  2969. Remarks:
  2970. Web triggers: A web trigger is created by typing "^webtrigger <target-uri>"
  2971. as the trigger command. In this case, the trigger will execute a POST query
  2972. against the specified URI -where the request body contains a JSON
  2973. dictionary with the trigger environment variables- and a fixed INPUT key
  2974. pointing to an array of strings.
  2975. Examples:
  2976. cm ^trigger ^create ^after-setselector "BackupMgr" "/path/to/script" --^position=4
  2977. cm ^tr ^mk ^before-mklabel new "/path/to/script" --^server=myserver:8084
  2978. cm ^tr ^mk ^after-mklabel Log "/path/to/script" --^filter="^rep:myRep,LB*"
  2979. (This trigger will be executed only if the label name starts with 'LB'
  2980. and it is being created in a repository called 'myRep'.)
  2981. cm ^tr ^mk ^after-checkin NotifyTeam "^webtrigger http://myserver.org/api"
  2982. == CMD_DESCRIPTION_MOVE ==
  2983. Moves or renames a file or directory.
  2984. == CMD_USAGE_MOVE ==
  2985. Usage:
  2986. cm ^move | ^mv <src_path> <dst_path> [--^format=<str_format>]
  2987. [--^errorformat=<str_format>]
  2988. src_path Source item path.
  2989. dst_path Destination item path.
  2990. Options:
  2991. --^format Retrieves the output message in a specific format. See
  2992. Remarks for more info.
  2993. --^errorformat Retrieves the error message in a specific format. See
  2994. Remarks for more info.
  2995. == CMD_HELP_MOVE ==
  2996. Remarks:
  2997. This command moves or renames an item in the repository.
  2998. Changes are done in the local filesystem too.
  2999. If the source path is a file, the destination path can be a file or a
  3000. directory. In the first case, the file is renamed; otherwise, the item
  3001. is moved.
  3002. If source path is a directory, the destination path must be a directory.
  3003. The item to move or rename must exist.
  3004. Format:
  3005. {0} Source path (both for '--^format' and '--^errorformat')
  3006. {1} Destination path (both for '--^format' and '--^errorformat')
  3007. Examples:
  3008. cm ^move file.txt file.old
  3009. (Renames the item.)
  3010. cm ^mv .\file.old .\oldFiles
  3011. (Moves 'file.old' to 'oldFiles'.)
  3012. cm ^move .\src .\src2
  3013. (Renames a directory.)
  3014. == CMD_DESCRIPTION_LABEL ==
  3015. Allows the user to manage labels.
  3016. == CMD_USAGE_LABEL ==
  3017. Usage:
  3018. cm ^label | ^lb <command> [options]
  3019. Commands:
  3020. ^create | ^mk
  3021. ^delete | ^rm
  3022. ^rename
  3023. To get more information about each command run:
  3024. cm ^label <command> --^usage
  3025. cm ^label <command> --^help
  3026. == CMD_HELP_LABEL ==
  3027. Examples:
  3028. cm ^label myNewLabel ^cs:42
  3029. ('^create' command is optional.)
  3030. cm ^label ^rename myNewLabel newLabelName
  3031. cm ^label ^delete newLabelName
  3032. == CMD_DESCRIPTION_LABEL_CREATE ==
  3033. Applies a label to a changeset and creates the label if required.
  3034. == CMD_USAGE_LABEL_CREATE ==
  3035. Usage:
  3036. cm ^label [^create] <lbspec> [<csetspec> | <wk_path>]
  3037. [--^allxlinkedrepositories]
  3038. [-^c=<str_comment> | -^commentsfile=<comments_file>]
  3039. lbspec The new label name.
  3040. (Use 'cm ^help ^objectspec' to learn more about label
  3041. specs.)
  3042. csetspec Name or full specification of the changeset to label.
  3043. (Use 'cm ^help ^objectspec' to learn more about changeset
  3044. specs.)
  3045. wk_path Path of the workspace to label. (The changeset that the
  3046. workspace is pointing will be labeled.)
  3047. Options:
  3048. --^allxlinkedrepositories Creates the new label in all Xlinked repositories.
  3049. -^c Applies the specified comment to the new label.
  3050. -^commentsfile Applies the comment in the specified file to the
  3051. new label.
  3052. == CMD_HELP_LABEL_CREATE ==
  3053. Remarks:
  3054. Set the PLASTICEDITOR environment variable to specify an editor for
  3055. entering comments. If the PLASTICEDITOR environment variable is set, and
  3056. the comment is empty, the editor will be automatically launched to allow
  3057. you to specify the comment.
  3058. Examples:
  3059. cm ^label ^create ^lb:BL001 ^cs:1203 -^commentsfile=commentlb001.txt
  3060. (Creates label 'BL001' attached to changeset 1203, and applies the comment
  3061. in the 'commentlb001.txt' file.)
  3062. cm ^label BL002 ^cs:1203 -^c="first release"
  3063. (Creates label 'BL002', with a comment, and attached to changeset 1203.)
  3064. == CMD_DESCRIPTION_LABEL_DELETE ==
  3065. Deletes one or more labels.
  3066. == CMD_USAGE_LABEL_DELETE ==
  3067. Usage:
  3068. cm ^label ^delete <lbspec>[ ...]
  3069. lbspec Label to delete. Use a whitespace to separate labels.
  3070. (Use 'cm ^help ^objectspec' to learn more about label
  3071. specs.)
  3072. == CMD_HELP_LABEL_DELETE ==
  3073. Remarks:
  3074. This command deletes one or more labels.
  3075. Examples:
  3076. cm ^label ^delete ^lb:BL001
  3077. (Deletes the label 'BL001'.)
  3078. cm ^label ^delete ^lb:BL001 ^lb:BL002@reptest@server2:8084
  3079. (Deletes the labels 'BL001' and 'BL002'.)
  3080. == CMD_DESCRIPTION_LABEL_RENAME ==
  3081. Renames a label.
  3082. == CMD_USAGE_LABEL_RENAME ==
  3083. Usage:
  3084. cm ^label ^rename <lbspec> <new_name>
  3085. lbspec Label to rename.
  3086. (Use 'cm ^help ^objectspec' to learn more about label specs.)
  3087. new_name New name for the label.
  3088. == CMD_HELP_LABEL_RENAME ==
  3089. Remarks:
  3090. This command renames a label.
  3091. Examples:
  3092. cm ^label ^rename ^lb:BL001 BL002
  3093. (Renames the label 'BL001' to 'BL002'.)
  3094. == CMD_DESCRIPTION_OBLITERATE ==
  3095. DEPRECATED
  3096. == CMD_USAGE_OBLITERATE ==
  3097. DEPRECATED.
  3098. == CMD_HELP_OBLITERATE ==
  3099. DEPRECATED.
  3100. == CMD_DESCRIPTION_OBJECTSPEC ==
  3101. Describes how to write object specs.
  3102. == CMD_USAGE_OBJECTSPEC ==
  3103. Usage:
  3104. cm ^objectspec
  3105. To get all the information about how to build object specs.
  3106. == CMD_HELP_OBJECTSPEC ==
  3107. Several Plastic SCM commands expect 'object specs' as input to refer to a
  3108. given object (typically a branch, changeset, repository, etc).
  3109. This documentation describes the different "specs" available and how to
  3110. build them.
  3111. Each spec type begins with a unique tag, for example "^rep:" or "^cs:". The tag
  3112. must be specified for commands that take a general object spec, for example
  3113. "cm ^setowner object_spec", but can often be omitted for commands that take only
  3114. a single type of spec, for example, "cm ^getfile revision_spec".
  3115. -- Repository server spec (repserverspec) --
  3116. ^repserver:name:port
  3117. Examples:
  3118. cm ^repo ^list ^repserver:skull:8084
  3119. cm ^repo ^list skull:8084
  3120. Side note:
  3121. We call it 'repository server spec', instead of just 'server spec' for
  3122. historical reasons. Long ago, we had separate workspace and repository
  3123. servers, and the naming survived.
  3124. -- Repository spec (repspec) --
  3125. ^rep:rep_name@[repserverspec]
  3126. Examples:
  3127. cm ^showowner ^rep:codice@localhost:6060
  3128. (Here the "^rep:" is required because ^showowner admits not only repos
  3129. but also other types of objects. So it needs the user to indicate the
  3130. object type.)
  3131. -- Branch spec (brspec) --
  3132. ^br:[/]br_name[@repspec]
  3133. Examples:
  3134. cm ^switch ^br:/main@^rep:plastic@^repserver:skull:9095
  3135. (In this case "^br:", "^rep" and "^repserver" are not needed, so the
  3136. command admits a much shorter form:
  3137. "cm ^switch main@plastic@skull:9095".)
  3138. cm ^find ^revisions "^where ^branch='^br:/main/task001'"
  3139. Remark:
  3140. The initial '/' on the branch is not mandatory. We used to specify all
  3141. our branches as /main, /main/task001, and so on. But now, we prefer the
  3142. shorter form main, main/task001 which makes commands more compact.
  3143. -- Changeset spec (csetspec) --
  3144. ^cs:cs_number|cs_guid[@repspec]
  3145. The number or GUID of the changeset can be specified.
  3146. Examples:
  3147. cm ^ls /code --^tree=ae1390ed-7ce9-4ec3-a155-e5a61de0dc77@code@skull:7070
  3148. -- Label spec (labelspec) --
  3149. ^lb:lb_name[@repspec]
  3150. Examples:
  3151. cm ^switch ^lb:RELEASE2.0
  3152. cm ^switch ^lb:RELEASE1.4@myrep@MYSERVER:8084
  3153. -- Revision spec --
  3154. There are different types of rev specs:
  3155. ^rev:item_path[#(brspec|csetspec|labelspec)]
  3156. ^rev:^serverpath:item_path#(brspec|cset_spec|lb_spec)
  3157. ^rev:^revid:rev_id[@rep_spec]
  3158. ^rev:^itemid:item_id#(br_spec|cset_spec|lb_spec)
  3159. Examples:
  3160. cm ^diff ^rev:readme.txt#^cs:19 ^rev:readme.txt#^cs:20
  3161. cm ^diff ^serverpath:/doc/readme.txt#^cs:19@myrepo \
  3162. ^serverpath:/doc/readme.txt#^br:/main@myrepo@localhost:8084
  3163. cm ^cat ^revid:1230@^rep:myrep@^repserver:myserver:8084
  3164. -- Item spec --
  3165. ^item:path
  3166. Rarely used.
  3167. Example:
  3168. cm ^find ^revision "^where ^item='^item:.'"
  3169. -- Attribute spec --
  3170. ^att:att_name[@repspec]
  3171. Example:
  3172. cm ^attribute ^set ^att:merged@code@doe:8084 ^cs:25@code@doe:8084 done
  3173. -- Shelve spec --
  3174. ^sh:sh_number[@repspec]
  3175. Example:
  3176. cm ^diff ^sh:2 ^sh:4
  3177. -- Workspace specs --
  3178. ^wk:name@clientmachine
  3179. Rarely used, since they only apply to workspace related commands. Useful to
  3180. specify the workspace by name and machine instead of path.
  3181. Examples:
  3182. cm ^showselector ^wk:codebase@modok
  3183. Side note:
  3184. These specs come from the old days of Plastic SCM 2.x where 'workspace
  3185. servers' existed as a way to store workspace metadata in a centralized
  3186. way. Were deprecated due to performance issues.
  3187. == CMD_DESCRIPTION_PARTIAL ==
  3188. Runs commands in a partial workspace.
  3189. == CMD_USAGE_PARTIAL ==
  3190. Usage:
  3191. cm ^partial <command> [options]
  3192. Commands:
  3193. ^configure
  3194. ^add
  3195. ^undo
  3196. ^co | ^checkout
  3197. ^unco | ^undocheckout
  3198. ^ci | ^checkin
  3199. ^mv | ^move
  3200. ^rm | ^remove
  3201. ^stb | ^switch
  3202. ^upd | ^update
  3203. ^shelve | ^shelveset
  3204. To get more information about each command run:
  3205. cm ^partial <command> --^usage
  3206. cm ^partial <command> --^help
  3207. == CMD_HELP_PARTIAL ==
  3208. Examples:
  3209. cm ^partial ^configure +/background-blue.png
  3210. cm ^partial ^update landscape-1024.png
  3211. cm ^partial ^checkin eyes-green.png eyes-black.png
  3212. == CMD_DESCRIPTION_PARTIAL_ADD ==
  3213. Adds an item to version control.
  3214. == CMD_USAGE_PARTIAL_ADD ==
  3215. Usage:
  3216. cm ^partial ^add [-^R | -^r | --^recursive] [--^silent] [--^parents]
  3217. [--^ignorefailed] [--^skipcontentcheck] <item_path>[ ...]
  3218. [--^format=<str-format>] [--^errorformat=<str-format>]
  3219. item_path Items to add. Use double quotes (" ") to specify paths
  3220. containing spaces. Use a whitespace to separate paths.
  3221. Use * to add all the contents of the current directory.
  3222. Options:
  3223. -^R Adds items recursively.
  3224. --^silent Does not show any output.
  3225. --^parents Includes the parent directories of the items specified
  3226. in the operation.
  3227. --^ignorefailed If an item cannot be added, the add operation will
  3228. continue without it. Note: If a directory cannot be
  3229. added, its content is not added.
  3230. --^skipcontentcheck When the extension is not enough to set the file as
  3231. text or binary, it will be set as binary by default
  3232. instead of checking the content to detect the type.
  3233. --^format Retrieves the output message in a specific format. Check
  3234. the examples for more information.
  3235. --^errorformat Retrieves the error message (if any) in a specific
  3236. format. Check the examples for more information.
  3237. == CMD_HELP_PARTIAL_ADD ==
  3238. Remarks:
  3239. Requirements to add items:
  3240. - The parent directory of the item to add must be previously added.
  3241. Examples:
  3242. cm ^partial ^add pic1.png pic2.png
  3243. (Adds 'pic1.png' and 'pic2.png' items.)
  3244. cm ^partial ^add c:\workspace\picture.png
  3245. (Adds 'picture.png' item in path 'c:\workspace'.)
  3246. cm ^partial ^add -^R c:\workspace\src
  3247. (Recursively adds 'src'.)
  3248. cm ^partial ^add --^parents samples\design01.png
  3249. (Adds 'design01.png' file and 'samples' parent folder.)
  3250. cm ^partial ^add -^R *
  3251. (Recursively adds all the contents of the current directory.)
  3252. cm ^partial ^add -^R * --^format="ADD {0}" --^errorformat="ERR {0}"
  3253. (Recursively adds all the contents of the current directory, printing
  3254. '^ADD <item>' for successfully added files, and '^ERR <item>' for items that
  3255. could not be added.)
  3256. == CMD_DESCRIPTION_PARTIAL_CHECKIN ==
  3257. Stores changes in the repository.
  3258. == CMD_USAGE_PARTIAL_CHECKIN ==
  3259. Usage:
  3260. cm ^partial ^checkin | ^ci [<item_path>[ ...]]
  3261. [-^c=<str_comment> | -^commentsfile=<comments_file>]
  3262. [--^all | -^a] [--^applychanged] [--^keeplock]
  3263. [--^symlink] [--^ignorefailed]
  3264. [--^machinereadable [--^startlineseparator=<sep>]
  3265. [--^endlineseparator=<sep>] [--^fieldseparator=<sep>]]
  3266. Options:
  3267. item_path Items to checkin. Use double quotes (" ") to specify
  3268. paths containing spaces. Use a whitespace to separate
  3269. paths.
  3270. Use . to apply checkin to current directory.
  3271. -^c Specifies a comment to the changeset created in the
  3272. checkin operation.
  3273. -^commentsfile Applies the comment from the specified file to the
  3274. changeset created in the checkin operation.
  3275. --^all | -^a Includes also the items changed, moved, and deleted
  3276. locally on the specified paths.
  3277. --^applychanged Applies the checkin operation to the changed items
  3278. detected in the workspace along with the checked out
  3279. items.
  3280. --^private Private items detected in the workspace are also
  3281. included.
  3282. --^keeplock Keeps the lock of the locked items after the checkin
  3283. operation.
  3284. --^symlink Applies the checkin operation to the symlink and not to
  3285. the target.
  3286. --^ignorefailed Any changes that cannot be applied (because the lock
  3287. - a.k.a. exclusive checkout - cannot be adquired or
  3288. because local changes are in conflict with the server
  3289. changes) are discarded and the checkin operation
  3290. continues without them.
  3291. --^machinereadable Outputs the result in an easy-to-parse format.
  3292. --^startlineseparator Used with the '--^machinereadable' flag, specifies how
  3293. the lines should start.
  3294. --^endlineseparator Used with the '--^machinereadable' flag, specifies how
  3295. the lines should end.
  3296. --^fieldseparator Used with the '--^machinereadable' flag, specifies how
  3297. the fields should be separated.
  3298. == CMD_HELP_PARTIAL_CHECKIN ==
  3299. Remarks:
  3300. - If <item_path> is not specified, the checkin will involve all the
  3301. pending changes in the workspace.
  3302. - The checkin operation always applies recursively from the given path.
  3303. - To checkin an item:
  3304. - The item must be under source code control.
  3305. - The item must be checked out.
  3306. - If the item is changed but not checked out, the '--^applychanged' flag
  3307. is not necessary unless <item_path> is a directory or it contains
  3308. wildcards ('*').
  3309. Revision content should be different from previous revision in order to be
  3310. checked in.
  3311. Set the PLASTICEDITOR environment variable to specify an editor for
  3312. entering comments. If the PLASTICEDITOR environment variable is set, and
  3313. the comment is empty, the editor will be automatically launched to allow
  3314. you to specify the comment.
  3315. Reading input from stdin:
  3316. The '^partial ^checkin' command can read paths from stdin. To do this, pass a
  3317. single dash "-".
  3318. Example: cm ^partial ^checkin -
  3319. Paths will be read until an empty line is entered.
  3320. This allows you to use pipe to specify which files to checkin.
  3321. Example:
  3322. dir /S /B *.c | cm ^partial ^checkin --^all -
  3323. (In Windows, checkins all .c files in the workspace.)
  3324. Examples:
  3325. cm ^partial ^checkin figure.png landscape.png
  3326. (Applies the checkin to 'figure.png' and 'landscape.png' checked-out files.)
  3327. cm ^partial ^checkin . -^commentsfile=mycomment.txt
  3328. (Applies checkin to current directory and sets the comment from the
  3329. 'mycomment.txt' file.)
  3330. cm ^partial ^ci background.png -^c="my comment" --^keeplock
  3331. (Applies the checkin to 'background.png', includes a comment, and keeps the
  3332. lock.)
  3333. cm ^partial ^checkin --^applychanged
  3334. (Applies the checkin to all pending changes in the workspace.)
  3335. cm ^partial ^checkin link --^symlink
  3336. (Applies the checkin to the symlink file and not to the target.)
  3337. cm ^partial ^checkin . --^ignorefailed
  3338. (Applies checkin to current directory, ignoring the changes that cannot be
  3339. applied.)
  3340. == CMD_DESCRIPTION_PARTIAL_CHECKOUT ==
  3341. Marks files as ready to modify.
  3342. == CMD_USAGE_PARTIAL_CHECKOUT ==
  3343. Usage:
  3344. cm ^partial ^checkout | ^co [<item_path>[ ...]] [--^resultformat=<str_format>]
  3345. [--^silent] [--^ignorefailed]
  3346. Options:
  3347. item_path Items to checkout. Use double quotes (" ") to specify
  3348. paths containing spaces. Use a whitespace to separate
  3349. paths.
  3350. Use . to apply checkout to current directory.
  3351. --^resultformat Retrieves the output result message in a specific
  3352. format.
  3353. --^silent Does not show any output.
  3354. --^ignorefailed If an item cannot be locked (the exclusive checkout
  3355. cannot be performed), the checkout operation will
  3356. continue without it.
  3357. == CMD_HELP_PARTIAL_CHECKOUT ==
  3358. Remarks:
  3359. To checkout an item:
  3360. - The item must be under source code control.
  3361. - The item must be checked in.
  3362. If locks are configured on the server (lock.conf exists), then each time
  3363. a checkout on a path happens, Plastic checks if it meets any of the rules
  3364. and if so, the path will be in exclusive checkout (locked) so that none can
  3365. simultaneously checkout.
  3366. You can get all the locks in the server by using 'cm ^lock ^list'.
  3367. Check the Administrator Guide to learn how locking works:
  3368. https://www.plasticscm.com/download/help/locking
  3369. Examples:
  3370. cm ^partial ^checkout pic1.png pic2.png
  3371. (Checkouts 'pic1.png' and 'pic2.png' files.)
  3372. cm ^partial ^co *.png
  3373. (Checkouts all png files.)
  3374. cm ^partial ^checkout .
  3375. (Checkouts current directory.)
  3376. cm ^partial ^checkout -^R c:\workspace\src
  3377. (Recursively checkouts 'src' folder.)
  3378. == CMD_DESCRIPTION_PARTIAL_CONFIGURE ==
  3379. Allows you to configure your workspace by loading or unloading items from it.
  3380. == CMD_USAGE_PARTIAL_CONFIGURE ==
  3381. Usage:
  3382. cm ^partial ^configure <+|-path>[ ...] [--^silent] [--^ignorefailed]
  3383. [--^ignorecase] [--^restorefulldirs]
  3384. [--^machinereadable [--^startlineseparator=<sep>]
  3385. [--^endlineseparator=<sep>] [--^fieldseparator=<sep>]]
  3386. path Paths to be loaded or unloaded. Use double quotes (" ") to
  3387. specify paths containing spaces. Use a whitespace to separate
  3388. paths.
  3389. Paths have to start with "/".
  3390. Options:
  3391. --^silent Does not show any output.
  3392. --^ignorefailed Skips all errors during the process. Incorrect paths
  3393. will not cause the command to stop.
  3394. --^ignorecase Ignores casing on the paths. With this flag, '^configure'
  3395. will work for "/Data/Textures" even if the user writes
  3396. "/data/teXtures".
  3397. --^restorefulldirs Resets an invalid directory configuration (happens when
  3398. a non-partial operation is run on a partial workspace).
  3399. The directories in this list will be fully configured
  3400. (full check) which means they will automatically
  3401. download new content during the update.
  3402. This operation does not download any files, just
  3403. restores the directory configuration on partial
  3404. workspaces.
  3405. --^machinereadable Outputs the result in an easy-to-parse format.
  3406. --^startlineseparator Used with the '--^machinereadable' flag, specifies how
  3407. the lines should start.
  3408. --^endlineseparator Used with the '--^machinereadable' flag, specifies how
  3409. the lines should end.
  3410. --^fieldseparator Used with the '--^machinereadable' flag, specifies how
  3411. the fields should be separated.
  3412. == CMD_HELP_PARTIAL_CONFIGURE ==
  3413. Remarks:
  3414. The command assumes recursive operation.
  3415. Examples:
  3416. cm ^partial ^configure +/landscape_grey.png
  3417. (Loads 'landscape_grey.png' item.)
  3418. cm ^partial ^configure -/landscape_black.png
  3419. (Unloads 'landscape_black.png' item.)
  3420. cm ^partial ^configure +/soft -/soft/soft-black.png
  3421. (Loads all 'soft' directory children items except 'soft-black.png'.)
  3422. cm ^partial ^configure -/
  3423. (Unloads the whole workspace.)
  3424. cm ^partial ^configure -/ +/
  3425. (Loads the whole workspace.)
  3426. cm ^partial ^configure -/figure-64.png --^ignorefailed
  3427. (Unloads 'figure-64.png' item even if it was already unloaded.)
  3428. cm ^partial ^configure +/ --^restorefulldirs
  3429. (Sets all directories to automatically download the new content.)
  3430. cm ^partial ^configure +/src/lib --^restorefulldirs
  3431. (Sets only '/src/lib' and its subdirectories to automatically download the
  3432. new content.)
  3433. == CMD_DESCRIPTION_PARTIAL_MOVE ==
  3434. Moves or renames a file or directory.
  3435. == CMD_USAGE_PARTIAL_MOVE ==
  3436. Usage:
  3437. cm ^partial ^move | ^mv <src_path> <dst_path> [--^format=<str_format>]
  3438. src_path Source item path.
  3439. dst_path Destination item path.
  3440. Options:
  3441. --^format Retrieves the output message in a specific format. See
  3442. Remarks for more info.
  3443. == CMD_HELP_PARTIAL_MOVE ==
  3444. Remarks:
  3445. This command moves or renames an item in the repository.
  3446. Changes are done in the local filesystem too.
  3447. If the source path is a file, the destination path can be a file or a
  3448. directory. In the first case, the file will be renamed; otherwise, the item
  3449. will be moved.
  3450. If source path is a directory, the destination path must be a directory.
  3451. The item to move or rename must exist.
  3452. Format:
  3453. {0} Source path.
  3454. {1} Destination path.
  3455. Examples:
  3456. cm ^partial ^move file.png file-blue.png
  3457. (Renames the item.)
  3458. cm ^partial ^mv .\file-blue.png .\blueFiles
  3459. (Moves 'file-blue.png' to 'blueFiles'.)
  3460. cm ^partial ^move .\design .\marketing
  3461. (Renames a directory.)
  3462. == CMD_DESCRIPTION_PARTIAL_RM ==
  3463. Deletes a file or directory from version control.
  3464. == CMD_USAGE_PARTIAL_RM ==
  3465. Usage:
  3466. cm ^partial ^remove | ^rm <item_path>[ ...] [--^nodisk]
  3467. item_path Items path to remove. Use double quotes (" ") to
  3468. specify paths containing spaces. Use a whitespace to separate
  3469. paths.
  3470. Options:
  3471. --^nodisk Removes from version control, but keeps the item on disk.
  3472. == CMD_HELP_PARTIAL_RM ==
  3473. Remarks:
  3474. Items are deleted from disk. Removed items are removed from the parent
  3475. directory in the source code control.
  3476. Requirements:
  3477. - The item must be under source code control.
  3478. Examples:
  3479. cm ^partial ^remove src
  3480. (Removes 'src'. If 'src' is a directory, this is the same that:
  3481. cm ^partial ^remove -^R src.)
  3482. cm ^partial ^remove c:\workspace\pic01.png --^nodisk
  3483. (Removes 'pic01.png' from version control, but keeps it on disk.)
  3484. == CMD_DESCRIPTION_PARTIAL_SHELVESET ==
  3485. Allows the user to manage partial shelvesets.
  3486. == CMD_USAGE_PARTIAL_SHELVESET ==
  3487. Usage:
  3488. cm ^partial ^shelveset | ^shelve <command> [options]
  3489. Commands:
  3490. ^create | ^mk
  3491. ^apply
  3492. ^delete | ^rm
  3493. To get more information about each command run:
  3494. cm ^partial ^shelveset <command> --^usage
  3495. cm ^partial ^shelveset <command> --^help
  3496. == CMD_HELP_PARTIAL_SHELVESET ==
  3497. Examples:
  3498. cm ^partial ^shelveset ^create -^c="my comment"
  3499. cm ^partial ^shelveset ^apply sh:3
  3500. cm ^partial ^shelveset ^delete sh:5
  3501. == CMD_DESCRIPTION_PARTIAL_SHELVESET_CREATE ==
  3502. Shelves chosen pending changes.
  3503. == CMD_USAGE_PARTIAL_SHELVESET_CREATE ==
  3504. Usage:
  3505. cm ^partial ^shelveset | ^shelve ^create | ^mk [<item_path>[ ...]]
  3506. [-^c=<str_comment> | -^commentsfile=<comments_file>]
  3507. [--^applychanged] [--^symlink] [--^ignorefailed]
  3508. [--^machinereadable [--^startlineseparator=<sep>]
  3509. [--^endlineseparator=<sep>] [--^fieldseparator=<sep>]]
  3510. Options:
  3511. item_path Items to shelve. Use double quotes (" ") to specify
  3512. paths containing spaces. Use a whitespace to separate
  3513. paths. Use . to apply shelve to current directory.
  3514. -^c Specifies a comment to the changeset created in the
  3515. shelve operation.
  3516. -^commentsfile Applies the comment from the specified file to the
  3517. changeset created in the shelve operation.
  3518. --^applychanged Applies the shelve operation to the changed items
  3519. detected in the workspace along with the checked out
  3520. items.
  3521. --^symlink Applies the shelve operation to the symlink and not to
  3522. the target.
  3523. --^ignorefailed Any changes that cannot be applied (because the lock
  3524. - a.k.a. exclusive checkout - cannot be adquired or
  3525. because local changes are in conflict with the server
  3526. changes) are discarded and the shelve operation
  3527. continues without them.
  3528. --^machinereadable Outputs the result in an easy-to-parse format.
  3529. --^startlineseparator Used with the '--^machinereadable' flag, specifies how
  3530. the lines should start.
  3531. --^endlineseparator Used with the '--^machinereadable' flag, specifies how
  3532. the lines should end.
  3533. --^fieldseparator Used with the '--^machinereadable' flag, specifies how
  3534. the fields should be separated.
  3535. == CMD_HELP_PARTIAL_SHELVESET_CREATE ==
  3536. The '^partial ^shelveset ^create' command stores the contents of checked out items
  3537. inside the repository. This way the contents are protected without the need to
  3538. checkin the files.
  3539. Remarks:
  3540. If neither <item_path> nor any option is specified, the shelveset will
  3541. include all the pending changes in the workspace.
  3542. The '^partial ^shelveset ^create' operation is always applied recursively from
  3543. the given path.
  3544. The '^partial ^shelveset ^create' operation is the default, which means that,
  3545. if no other operation is defined, the command will try to perform a creation.
  3546. Requirements to shelve an item:
  3547. - The item must be under source code control.
  3548. - The item must be checked out or changed.
  3549. Set the PLASTICEDITOR environment variable to specify an editor for
  3550. entering comments. If the PLASTICEDITOR environment variable is set, and
  3551. the comment is empty, the editor will be automatically launched to allow
  3552. you to specify the comment.
  3553. Examples:
  3554. cm ^partial ^shelveset figure.png landscape.png
  3555. (Creates a new shelveset with 'figure.png' and 'landscape.png' checked-out files.)
  3556. cm ^partial ^shelveset . -^commentsfile=mycomment.txt
  3557. (Creates a new shelveset with every checked-out file in current directory
  3558. and sets the comment from the 'mycomment.txt' file.)
  3559. cm ^partial ^shelve background.png -^c="my comment"
  3560. (Creates a new shelveset with 'background.png', includes a comment.)
  3561. cm ^partial ^shelveset --^applychanged
  3562. (Creates a new shelveset all pending changes in the workspace.)
  3563. cm ^partial ^shelveset link --^symlink
  3564. (Creates a new shelveset with the symlink file and not the target.)
  3565. cm ^partial ^shelveset . --^ignorefailed
  3566. (Creates a new shelveset with every checked-out file in current directory,
  3567. ignoring (skipping) the changes that cannot be applied.)
  3568. == CMD_DESCRIPTION_PARTIAL_SHELVESET_APPLY ==
  3569. Applies a stored shelveset.
  3570. == CMD_USAGE_PARTIAL_SHELVESET_APPLY ==
  3571. Usage:
  3572. cm ^partial ^shelveset ^apply <sh_spec> [--^encoding=<name>]
  3573. [--^comparisonmethod=(^ignoreeol | ^ignorewhitespaces| \
  3574. ^ignoreeolandwhitespaces | ^recognizeall)]
  3575. sh_spec Shelveset specification. (Use 'cm ^help ^objectspec' to
  3576. learn more about shelveset specs.)
  3577. Options:
  3578. --^encoding Specifies the output encoding, i.e.: utf-8.
  3579. See the MSDN documentation at
  3580. http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx
  3581. to get the table of supported encodings and its format,
  3582. (at the end of the page, in the "Name" column).
  3583. --^comparisonmethod Sets the comparison method. See Remarks for more info.
  3584. == CMD_HELP_PARTIAL_SHELVESET_APPLY ==
  3585. The '^partial ^shelveset ^apply' command restores the contents of a stored shelveset.
  3586. Remarks:
  3587. Comparison methods:
  3588. ^ignoreeol Ignores end of line differences.
  3589. ^ignorewhitespaces Ignores whitespace differences.
  3590. ^ignoreeolandwhitespaces Ignores end of line and whitespace differences.
  3591. ^recognizeall Detects end of line and whitespace differences.
  3592. Examples:
  3593. cm ^partial ^shelveset ^apply ^sh:3
  3594. (Applies a stored shelve.)
  3595. == CMD_DESCRIPTION_PARTIAL_SHELVESET_DELETE ==
  3596. Deletes a shelveset.
  3597. == CMD_USAGE_PARTIAL_SHELVESET_DELETE ==
  3598. Usage:
  3599. cm ^partial ^shelveset ^delete | ^rm <sh_spec>
  3600. sh_spec Shelveset specification. (Use 'cm ^help ^objectspec' to
  3601. learn more about shelveset specs.)
  3602. == CMD_HELP_PARTIAL_SHELVESET_DELETE ==
  3603. The '^partial ^shelveset ^delete' command deletes a shelveset.
  3604. Examples:
  3605. cm ^partial ^shelveset ^delete ^sh:3
  3606. (Removes a stored shelveset.)
  3607. == CMD_DESCRIPTION_PARTIAL_SWITCH ==
  3608. Sets a branch as the working branch.
  3609. == CMD_USAGE_PARTIAL_SWITCH ==
  3610. Usage:
  3611. cm ^switch <branch_spec> [--^report | --^silent] [--^workspace=<path>]
  3612. (Sets the working branch and updates the workspace.)
  3613. cm ^switch <branch_spec> --^configure <+|-path>[ ...] [--^silent]
  3614. [--^ignorefailed] [--^ignorecase] [--^workspace=<path>]
  3615. (Sets the working branch and runs a workspace configuration like the 'cm
  3616. ^partial ^configure' command does.)
  3617. branch_spec Branch specification. (Use 'cm ^help ^objectspec' to learn
  3618. more about branch specs.)
  3619. path Paths to be loaded or unloaded. Use double quotes (" ")
  3620. to specify paths containing spaces. Use a whitespace to
  3621. separate paths. Paths must start with "/".
  3622. Options:
  3623. --^silent Does not show any output.
  3624. --^report Prints a list of the applied changes when the command
  3625. is finished. Using '--^silent' will override this setting.
  3626. This option only works when the '--^configure' option
  3627. is not specified.
  3628. --^configure Configures (loads / unloads items) the workspace
  3629. after updating the working branch. Check 'cm ^partial
  3630. ^configure --^help' to learn how to specify the paths
  3631. to configure.
  3632. --^ignorefailed Skips all errors during the configuration process.
  3633. Incorrect paths will not cause the command to stop.
  3634. --^ignorecase Ignores casing on the paths. With this flag, option
  3635. '--^configure' works for "/Data/Textures" even if the user
  3636. writes "/data/teXtures".
  3637. --^workspace=path Path where the workspace is located.
  3638. == CMD_HELP_PARTIAL_SWITCH ==
  3639. Remarks:
  3640. This command allows users to update the working branch. After updating the
  3641. branch, the command updates the workspace to the new branch as the
  3642. 'cm ^partial ^update' command would do. However, if the '--^configure' option is
  3643. specified, the command allows to configure the workspace using the new
  3644. branch configuration as the 'cm ^partial ^configure' command would do.
  3645. Examples:
  3646. cm ^switch ^br:/main/task
  3647. (Sets /main/task as working branch and updates the workspace.)
  3648. cm ^switch ^br:/main/task --^configure +/art/images
  3649. (Sets /main/task as working branch and configures the workspace to
  3650. load the /art/images folder.)
  3651. == CMD_DESCRIPTION_PARTIAL_UNCO ==
  3652. Undoes the checkout on an item.
  3653. == CMD_USAGE_PARTIAL_UNCO ==
  3654. Usage:
  3655. cm ^partial ^undocheckout | ^unco <item_path>[ ...] [--^silent]
  3656. item_path Items to apply the operation. Use double quotes (" ")
  3657. to specify paths containing spaces. Use a whitespace to
  3658. separate paths.
  3659. Use . to apply the operation to current directory.
  3660. Options:
  3661. --^silent Does not show any output.
  3662. == CMD_HELP_PARTIAL_UNCO ==
  3663. Remarks:
  3664. If an item is checked-out and you do not want to checkin it, you can undo
  3665. the checkout using this command. Both files and folders can be unchecked
  3666. out. The item will be updated to the state it had before checking it out.
  3667. Requirements:
  3668. - The item must be under source code control.
  3669. - The item must be checked out.
  3670. Examples:
  3671. cm ^partial ^undocheckout .
  3672. (Undoes checkouts in the current directory.)
  3673. cm ^partial ^undocheckout pic1.png pic2.png
  3674. cm ^unco c:\workspace\design01.png
  3675. (Undoes checkouts of the selected files.)
  3676. == CMD_DESCRIPTION_PARTIAL_UNDO ==
  3677. Undoes changes in a workspace.
  3678. == CMD_USAGE_PARTIAL_UNDO ==
  3679. Usage:
  3680. cm ^partial ^undo [<path>[ ...]] [--^symlink] [-^r | --^recursive]
  3681. [<filter>[ ...]]
  3682. [--^silent | --^machinereadable [--^startlineseparator=<sep>]
  3683. [--^endlineseparator=<sep>] [--^fieldseparator=<sep>]]
  3684. path Path of the files or directories to apply the
  3685. operation to. Use double quotes (" ") to specify
  3686. paths containing spaces. Use a whitespace to
  3687. separate paths.
  3688. If no path is specified, by default the undo
  3689. operation will take all of the files in the current
  3690. directory.
  3691. filter Applies the specified filter or filters to the given
  3692. paths. Use a whitespace to separate filters. See the
  3693. Filters section for more information.
  3694. Options:
  3695. --^symlink Applies the undo operation to the symlink and not
  3696. to the target.
  3697. -^r Executes the undo recursively.
  3698. --^silent Does not show any output.
  3699. --^machinereadable Outputs the result in an easy-to-parse format.
  3700. --^startlineseparator Used with the '--^machinereadable' flag, specifies
  3701. how the lines should start.
  3702. --^endlineseparator Used with the '--^machinereadable' flag, specifies
  3703. how the lines should end.
  3704. --^fieldseparator Used with the '--^machinereadable' flag, specifies
  3705. how the fields should be separated.
  3706. Filters:
  3707. If no flag is specified, by default, all changes are undone, but the
  3708. paths can be filtered using one or more of the flags below.
  3709. If a file or directory matches one or more of the specified kinds of change,
  3710. all of the changes on said file or directory will be undone.
  3711. For example, if you specify both '--^checkedout' and '--^moved', if a file is
  3712. both checkedout and moved, both changes will be undone.
  3713. --^checkedout Select checked-out files and directories.
  3714. --^unchanged Select files whose content is unchanged.
  3715. --^changed Select locally changed or checked-out files and
  3716. directories.
  3717. --^deleted Select deleted files and directories.
  3718. --^moved Select moved files and directories.
  3719. --^added Select added files and directories.
  3720. == CMD_HELP_PARTIAL_UNDO ==
  3721. Remarks:
  3722. The ^undo command is dangerous - it undoes work in an irreversible way.
  3723. Once the ^undo has finished, it is not possible to recover the previous state
  3724. of the files and directories affected by it. If no path is specified
  3725. in the arguments, by default it will undo every change in the current
  3726. directory, but not recursively.
  3727. These are equivalent when executed from the /src directory:
  3728. /src
  3729. |- file.txt
  3730. |- code.cs
  3731. \- /test
  3732. |- test_a.py
  3733. \- test_b.py
  3734. cm ^partial ^undo
  3735. cm ^partial ^undo *
  3736. cm ^partial ^undo file.txt code.cs /test
  3737. cm ^partial ^undo .
  3738. cm ^partial ^undo /src file.txt code.cs
  3739. If you want the operation to be recursive, you must specify the '-^r' flag.
  3740. To undo all of the changes below a directory (including changes affecting
  3741. the directory itself):
  3742. cm ^partial ^undo dirpath -^r
  3743. If dirpath is a workspace path, every change in the workspace will be
  3744. undone.
  3745. Examples:
  3746. cm ^partial ^undo . -^r
  3747. (Undoes all changes in the current directory recursively. If executed
  3748. from the workspace's root, undoes all changes in the entire workspace.)
  3749. cm ^partial ^co file.txt
  3750. cm ^partial ^undo file.txt
  3751. (Undoes the checkout on file.txt.)
  3752. ^echo ^content >> file.txt
  3753. cm ^partial ^undo file.txt
  3754. (Undoes the local change to file.txt.)
  3755. cm ^partial ^undo src
  3756. (Undoes changes to the src directory and its files.)
  3757. cm ^partial ^undo src/*
  3758. (Undo changes in every file and directory contained in src, without
  3759. affecting src.)
  3760. cm ^partial ^undo *.cs
  3761. (Undo changes to every file or directory that matches *.cs in the current
  3762. directory.)
  3763. cm ^partial ^undo *.cs -^r
  3764. (Undoes changes on every file or directory that matches *.cs in the current
  3765. directory and every directory below it.)
  3766. cm ^partial ^co file1.txt file2.txt
  3767. ^echo ^content >> file1.txt
  3768. cm ^partial ^undo --^unchanged
  3769. (Undoes the checkout of unchanged file2.txt, ignoring locally changed
  3770. file1.txt.)
  3771. ^echo ^content >> file1.txt
  3772. ^echo ^content >> file2.txt
  3773. cm ^partial ^co file1.txt
  3774. cm ^partial ^undo --^checkedout
  3775. (Undoes the changes in checked-out file file1.txt, ignoring file2.txt as it is
  3776. not checked-out.)
  3777. cm ^partial ^add file.txt
  3778. cm ^partial ^undo file.txt
  3779. (Undoes the add of file.txt, making it once again a private file.)
  3780. ^rm file1.txt
  3781. ^echo ^content >> file2.txt
  3782. cm ^partial ^add file3.txt
  3783. cm ^partial ^undo --^deleted --^added *
  3784. (Undoes the file1.txt delete and file3.txt add, ignoring the file2.txt
  3785. change.)
  3786. == CMD_DESCRIPTION_PARTIAL_UPDATE ==
  3787. Updates the partial workspace and downloads latest changes.
  3788. == CMD_USAGE_PARTIAL_UPDATE ==
  3789. Usage:
  3790. cm ^partial ^update [<item_path>[ ...]] [--^changeset=<number>]
  3791. [--^silent | --^report] [--^dontmerge]
  3792. [--^machinereadable [--^startlineseparator=<sep>]
  3793. [--^endlineseparator=<sep>] [--^fieldseparator=<sep>]]
  3794. item_path Items to be updated. Use double quotes (" ") to specify
  3795. paths containing spaces. Use a whitespace to separate
  3796. paths.
  3797. Use . to apply update to current directory.
  3798. If no path is specified, then the current partial
  3799. workspace is fully updated.
  3800. Options:
  3801. --^changeset Updates the partial workspace to a specific changeset.
  3802. --^silent Does not show any output.
  3803. --^report Prints a list of the applied changes when the command
  3804. is finished. Using '--^silent' will override this setting.
  3805. --^dontmerge Does not merge the file conflicts, it just skips them.
  3806. The other changes are properly applied. This option can
  3807. be useful for automation to avoid user interaction.
  3808. --^machinereadable Outputs the result in an easy-to-parse format.
  3809. --^startlineseparator Used with the '--^machinereadable' flag,
  3810. specifies how the lines should start.
  3811. --^endlineseparator Used with the '--^machinereadable' flag,
  3812. specifies how the lines should end.
  3813. --^fieldseparator Used with the '--^machinereadable' flag,
  3814. specifies how the fields should be separated.
  3815. == CMD_HELP_PARTIAL_UPDATE ==
  3816. Remarks:
  3817. The '^partial ^update' command updates the out-of-date files.
  3818. The command assumes recursive operation.
  3819. If all the specified paths are files inside the same Xlink when using the
  3820. '--^changeset' option, then the versions to download are searched in the
  3821. specified changeset of the Xlinked repository.
  3822. Examples:
  3823. cm ^partial ^update
  3824. (Updates all in the current partial workspace.)
  3825. cm ^partial ^update .
  3826. (Updates all current directory children items.)
  3827. cm ^partial ^update backgroud-blue.png
  3828. (Updates 'backgroud-blue.png' item.)
  3829. cm ^partial ^update soft_black.png soft-grey.png
  3830. (Updates 'soft_black.png' and 'soft-grey.png' items.)
  3831. cm ^partial ^update src --^report
  3832. (Updates all 'src' directory children items, printing the applied changes
  3833. list at the end.)
  3834. cm ^partial ^update src --^changeset=4
  3835. (Updates all 'src' directory children items to the content they loaded
  3836. in the changeset 4.)
  3837. cm ^partial ^update xlink/first.png --^changeset=4
  3838. (Updates 'xlink/first.png' item to the content it loaded in the changeset 4
  3839. of the Xlinked repository.)
  3840. == CMD_DESCRIPTION_PATCH ==
  3841. Generates a patch file from a spec or applies a generated patch to the current
  3842. workspace.
  3843. == CMD_USAGE_PATCH ==
  3844. Usage:
  3845. cm ^patch <source_spec> [<source_spec>] [--^output=<output_file>]
  3846. [--^tool=<path_to_diff>]
  3847. Generates a patch file that contains the differences of a branch,
  3848. a changeset, or the differences between changesets. It also tracks
  3849. differences of text and binary files.
  3850. cm ^patch --^apply <patch_file> [--^tool=<path_to_patch>]
  3851. Allows to apply the contents of a generated patch file in the current
  3852. workspace.
  3853. source_spec Full spec of a changeset or a branch. (Use
  3854. 'cm ^help ^objectspec' to learn more about specs.)
  3855. output_file File to save the patch content. It no file is specified,
  3856. the patch content will be printed on standard output.
  3857. patch_file Patch file to apply in the current workspace.
  3858. Options:
  3859. --^output Sets the output file of the patch command.
  3860. --^tool Sets the application to use (diff or patch).
  3861. == CMD_HELP_PATCH ==
  3862. Limitations:
  3863. If the output patch file already exists, the command will not overwrite it.
  3864. When applying a patch, the command will not apply changes to modified files
  3865. if they are not present on disk.
  3866. Important:
  3867. This command requires Diff and Patch tools, publicly available at
  3868. http://gnuwin32.sourceforge.net/packages/patch.htm and
  3869. http://gnuwin32.sourceforge.net/packages/diffutils.htm
  3870. Once installed, it's recommended to add their location to the PATH
  3871. environment variable.
  3872. Examples:
  3873. cm ^patch ^cs:4@default@localhost:8084
  3874. (Prints on console the differences of cset 4 in unified format.)
  3875. cm ^patch ^br:/main --^output=file.patch
  3876. (Generates a patch file with the differences of branch "main".)
  3877. cm ^patch ^br:/main --^output=file.patch --^tool=C:\gnu\diff.exe
  3878. (Same as above, using a custom exe.)
  3879. cm ^patch ^cs:2@default ^cs:4@default
  3880. (Prints on console the differences between csets 2 and 4 in unified format.)
  3881. cm ^patch --^apply file.patch --^tool=C:\gnu\patch.exe
  3882. (Applies the patch in 'file.patch' to the local workspace with a custom exe.)
  3883. == CMD_DESCRIPTION_PROFILE ==
  3884. Allows the user to manage server connection profiles.
  3885. == CMD_USAGE_PROFILE ==
  3886. Usage:
  3887. cm ^profile <command> [options]
  3888. Commands:
  3889. ^list | ^ls
  3890. ^create | ^mk
  3891. ^delete | ^rm
  3892. To get more information about each command run:
  3893. cm ^profile <command> --^usage
  3894. cm ^profile <command> --^help
  3895. == CMD_HELP_PROFILE ==
  3896. Examples:
  3897. cm ^profile
  3898. cm ^profile ^list
  3899. cm ^profile ^create
  3900. cm ^profile ^delete 1
  3901. == CMD_DESCRIPTION_PROFILE_LIST ==
  3902. Lists the server connection profiles configured on the client.
  3903. == CMD_USAGE_PROFILE_LIST ==
  3904. Usage:
  3905. cm ^profile [^list | ^ls] [--^format=<str_format>]
  3906. Options:
  3907. --^format Retrieves the output message in a specific format.
  3908. See Remarks for more info.
  3909. == CMD_HELP_PROFILE_LIST ==
  3910. Remarks:
  3911. Output format parameters (--^format option):
  3912. This command accepts a format string to show the output.
  3913. The output parameters of this command are the following:
  3914. {^index} | {0} Profile index in the profiles list
  3915. {^name} | {1} Profile name
  3916. {^server} | {2} Profile server
  3917. {^user} | {3} Profile user
  3918. {^workingmode} | {4} Profile working mode
  3919. {^securityconfig} | {5} Profile security config
  3920. {^tab} Inserts a tab space
  3921. {^newline} Inserts a new line
  3922. Examples:
  3923. cm ^profile
  3924. (Lists all the profiles using the default format)
  3925. cm ^profile --^format="{index,2} {server,-20}"
  3926. (Writes the profile index in 2 spaces, aligned to the right, then two blanks,
  3927. and then the repository server in 20 spaces, aligned to the left.)
  3928. cm ^profile --^format="{0,2} {2,-20}"
  3929. (Writes the same output as the previous example.)
  3930. == CMD_DESCRIPTION_PROFILE_CREATE ==
  3931. Creates a new server connection profile.
  3932. == CMD_USAGE_PROFILE_CREATE ==
  3933. Usage:
  3934. cm ^profile [^create | ^mk]
  3935. (Creates a new profile interactively.)
  3936. cm ^profile [^create | ^mk] --^server=<server_addr> --^username=<username>
  3937. --^password=<password> --^workingmode=<workingmode>
  3938. (Creates a new server connection profile using a user/password
  3939. authentication mode.)
  3940. cm ^profile [^create | ^mk] --^server=<server_addr> --^username=<username>
  3941. --^token=<token> --^workingmode=SSOWorkingMode
  3942. (Creates a new server connection profile using Single Sign On authentication
  3943. mode.)
  3944. Options:
  3945. --^server Creates the connection profile for the specified server.
  3946. --^username The username that should be used in the connection profile
  3947. --^password The plain-text password that should be used in the connection
  3948. profile. This option is only valid for authentication modes
  3949. that are based on a user and password.
  3950. --^token The plain-text token that should be used in the connection
  3951. profile. This option is only valid for authentication modes
  3952. that are based on a token (SSOWorkingMode for now).
  3953. --^workingmode The target server's authentication mode.
  3954. Available users/security working modes:
  3955. ^LDAPWorkingMode (LDAP)
  3956. ^UPWorkingMode (User and password)
  3957. ^SSOWorkingMode (Single Sign On)
  3958. == CMD_HELP_PROFILE_CREATE ==
  3959. Remarks:
  3960. When using this command interactively (without options), the client will try
  3961. to connect to the server to obtain the working mode and check the credentials.
  3962. This guarantees that the resulting profile is correct.
  3963. When specifying the options, the client will generate the connection profile
  3964. without connecting to the server. This is useful when creating connection
  3965. profiles for automation purposes.
  3966. Examples:
  3967. cm ^profile ^create
  3968. (Creates a new connection profile interactively.)
  3969. cm ^profile ^create --^server=plastic.domain.com:8087 --^username=sergio
  3970. --^password=thisissupersecret --^workingmode=LDAPWorkingMode
  3971. (Creates a new connection profile to connect to 'plastic.domain.com:8087'
  3972. using user 'sergio' and password 'thisissupersecret' through LDAP working mode.)
  3973. cm ^profile ^create --^server=plastic.domain.com:8087 --^username=sergio
  3974. --^token="TOKENAMoKJ9iAA(...)12fssoprov:unityid" --workingmode=^SSOWorkingMode
  3975. (Creates a new connection profile to connect to 'plastic.domain.com:8087'
  3976. using user 'sergio' and the specified token through Single Sign On working mode.)
  3977. == CMD_DESCRIPTION_PROFILE_DELETE ==
  3978. Deletes a server connection profile from the client's configuration.
  3979. == CMD_USAGE_PROFILE_DELETE ==
  3980. Usage:
  3981. cm ^profile ^delete | ^rm <index | name>
  3982. cm ^profile ^delete | ^rm --index=<index>
  3983. cm ^profile ^delete | ^rm --name=<name>
  3984. index Profile index in the profiles list.
  3985. name Profile name.
  3986. Options:
  3987. --index Used to disambiguate in case a profile has a name that is a number
  3988. --name Used to disambiguate in case a profile has a name that is a number
  3989. == CMD_HELP_PROFILE_DELETE ==
  3990. Remarks:
  3991. Deletes a server connection profile from the client's configuration.
  3992. It works both with the profile index and the profile name.
  3993. The 'cm ^profile ^list' command does not show profile names by default,
  3994. check 'cm ^profile ^list --help' to check how to output profile's name.
  3995. Example:
  3996. cm ^profile ^delete 1
  3997. (Removes the profile at index 1.)
  3998. cm ^profile ^delete 192.168.0.2:8087_UPWorkingMode
  3999. (Removes the profile with name '192.168.0.2:8087_UPWorkingMode'.)
  4000. cm ^profile ^delete --name=12
  4001. (Removes the profile with name '12'.)
  4002. == CMD_DESCRIPTION_QUERY ==
  4003. Executes SQL queries. Requires SQL storage.
  4004. == CMD_USAGE_QUERY ==
  4005. Usage:
  4006. cm ^query <sql_command> [--^outputfile=<output_file>]
  4007. [--^solveuser=<column_name>[,...]]
  4008. [--^solvepath=<column_name>[,...]]
  4009. [--^columnwidth=<value>] [--^nocolumnname]
  4010. [--^columnseparator=<sep>] [--^repository=<name>]
  4011. sql_command The sql query to be executed.
  4012. Options:
  4013. --^outputfile Writes the result in an output file.
  4014. --^solveuser Sets the specified columns as username columns. The
  4015. query interpreter will assume that data of these columns
  4016. will be users, and will try to solve them.
  4017. --^solvepath Sets the specified columns as itemid column. The query
  4018. interpreter will try to solve item id to filesystem
  4019. paths.
  4020. --^columnwidth Specifies the width of each column to format the output.
  4021. --^nocolumnname Does not print column name.
  4022. --^columnseparator Uses char as column separator instead of a tab (\t).
  4023. --^repository Repository to query.
  4024. == CMD_HELP_QUERY ==
  4025. Remarks:
  4026. This command allows users to execute SQL queries in the server database.
  4027. In order to write SQL queries, use these two pre-defined functions to manage
  4028. users and paths:
  4029. - '^SolveUser(<username>)' that resolves a username into Plastic SCM format.
  4030. - '^SolvePath(<path>)' that resolves a disk path into an item id.
  4031. Also, you can use options to show query results in a human readable form.
  4032. You can use the options '--^solveuser=<column_name>' and
  4033. '--^solvepath=<column_name>' to specify columns that query interpreter
  4034. must convert to a legible text. You can specify more than one column name,
  4035. comma separated.
  4036. Examples:
  4037. cm ^query "^SELECT * ^FROM ^revision" --^columnwidth=25 --^repository=reptest
  4038. (Retrieves data from 'revision' table from repository 'reptest'.)
  4039. cm ^query "^SELECT b.^sname ^as br_name, o.^dtimestamp ^as date ^from ^branch b, \
  4040. ^object o, ^seid s ^where b.^iobjid=o.^iobjid ^and o.^fidowner=s.^iseidid ^and \
  4041. s.^scode='^SolveUser(john)'" --^outputfile=query.txt
  4042. (Outputs into a file the branches with owner 'john'.)
  4043. cm ^query "^select r.^iobjid, r.^fiditem ^as path, s.^scode ^as username ^FROM \
  4044. ^revision r, ^object o, ^seid s ^WHERE r.^iobjid=o.^iobjid ^and \
  4045. o.^fidowner=s.^iseidid ^and o.^dtimestamp>04/25/2014" \
  4046. --^solveuser=username --^solvepath=path --^repository=reptest@server2:9095
  4047. (Retrieves selected data from selected repository.)
  4048. cm ^query "^SELECT * ^FROM ^revision ^WHERE ^fiditem=^SolvePath(c:\mywkpath\info)"
  4049. (Retrieves all revision data of path 'info'.)
  4050. == CMD_DESCRIPTION_ATTRIBUTE_DELETE ==
  4051. Deletes one or more attributes.
  4052. == CMD_USAGE_ATTRIBUTE_DELETE ==
  4053. Usage:
  4054. cm ^attribute | ^att ^delete | ^rm <att_spec>[ ...]
  4055. att_spec Attributes to delete. Use a whitespace to separate
  4056. attributes.
  4057. (Use 'cm ^help ^objectspec' to learn more about attribute
  4058. specs.)
  4059. == CMD_HELP_ATTRIBUTE_DELETE ==
  4060. Remarks:
  4061. This command removes one or more attributes.
  4062. Examples:
  4063. cm ^attribute ^delete ^att:status
  4064. (Deletes the attribute 'status'.)
  4065. cm ^att ^rm status ^att:integrated@reptest@server2:8084
  4066. (Deletes the attributes 'status' and 'integrated'.)
  4067. == CMD_DESCRIPTION_ATTRIBUTE_UNSET ==
  4068. Unsets an object's attribute.
  4069. == CMD_USAGE_ATTRIBUTE_UNSET ==
  4070. Usage:
  4071. cm ^attribute | ^att ^unset <att_spec> <object_spec>
  4072. att_spec Attribute specification. (Use 'cm ^help ^objectspec' to
  4073. learn more about attribute specs.)
  4074. object_spec Specification of the object to remove the attribute
  4075. from. Attributes can be set on: branches, changesets,
  4076. shelvesets, labels, items, and revisions.
  4077. (Use 'cm ^help ^objectspec' to learn more about specs.)
  4078. == CMD_HELP_ATTRIBUTE_UNSET ==
  4079. Remarks:
  4080. The command unsets an attribute that was previously set on an object. It
  4081. does not delete the attribute object itself.
  4082. Examples:
  4083. cm ^attribute ^unset ^att:status ^br:/main/SCM105
  4084. (Removes attribute realization 'status' from branch 'main/SCM105'.)
  4085. cm ^att ^unset ^att:integrated@reptest@localhost:8084 ^cs:25@reptest@localhost:8084
  4086. (Removes attribute realization 'integrated' from changeset 25, all in
  4087. repository 'reptest'.)
  4088. == CMD_DESCRIPTION_ATTRIBUTE_RENAME ==
  4089. Renames an attribute.
  4090. == CMD_USAGE_ATTRIBUTE_RENAME ==
  4091. Usage:
  4092. cm ^attribute | ^att ^rename <att_spec> <new_name>
  4093. att_spec Attribute to rename. (Use 'cm ^help ^objectspec' to learn
  4094. more about attribute specs.)
  4095. new_name New name for the attribute.
  4096. == CMD_HELP_ATTRIBUTE_RENAME ==
  4097. Remarks:
  4098. This command renames an attribute.
  4099. Examples:
  4100. cm ^attribute ^rename ^att:status state
  4101. (Renames the attribute 'status' to 'state'.)
  4102. == CMD_DESCRIPTION_ATTRIBUTE_EDIT ==
  4103. Edits the comment of an attribute.
  4104. == CMD_USAGE_ATTRIBUTE_EDIT ==
  4105. Usage:
  4106. cm ^attribute | ^att ^edit <att_spec> <new_comment>
  4107. att_spec Attribute to change its comment. (Use 'cm ^help ^objectspec'
  4108. to learn more about attribute specs.)
  4109. new_comment New comment for the attribute. You can also specify a
  4110. default list of values for the attribute. See Remarks for
  4111. more info.
  4112. == CMD_HELP_ATTRIBUTE_EDIT ==
  4113. Remarks:
  4114. This command changes the comment of an attribute.
  4115. To specify a default list of values for the attribute, you just need to
  4116. include a line like the following in the attribute comment:
  4117. 'default: value_one, "value two", value3, "Final value"'.
  4118. Examples:
  4119. cm ^attribute ^edit ^att:status "The status of a branch in the CI pipeline."
  4120. (Edits the comment of the attribute 'status'.)
  4121. cm ^attribute ^edit ^att:status "Status of a branch. default: open, resolved, reviewed"
  4122. (Edits the comment of the attribute 'status'. And also specifies a list of
  4123. values. So when you set the attribute 'status' to an object, you can select
  4124. one of the following values: "open", "resolved", or "reviewed".)
  4125. == CMD_DESCRIPTION_REPLICATE ==
  4126. WARNING: This command is deprecated.
  4127. Use 'cm ^pull' (equivalent to '^replicate') and 'cm ^push' (equivalent to
  4128. '^replicate --^push').
  4129. == CMD_USAGE_REPLICATE ==
  4130. == CMD_HELP_REPLICATE ==
  4131. == CMD_DESCRIPTION_PULL ==
  4132. Pulls a branch from another repo.
  4133. == CMD_USAGE_PULL ==
  4134. Usage:
  4135. cm ^pull <src_br_spec> <dst_rep_spec>
  4136. [--^preview] [--^nodata] [TranslateOptions]
  4137. [--^user=<usr_name> [--^password=<pwd>] | AuthOptions]
  4138. (Direct server-to-server replication. Pulls a branch from a repository.)
  4139. cm ^pull <dst_rep_spec> --^package=<pack_file> [AuthOptions]
  4140. (Package based replication. Imports the package in the destination repository.)
  4141. cm ^pull ^hydrate <dst_br_spec> [<src_rep_spec>]
  4142. [--^user=<usr_name> [--^password=<pwd>] | AuthOptions]
  4143. (Introduces the missing data for all the changesets of a branch previously
  4144. replicated with '--^nodata'. If a repo to obtain the data is not specified,
  4145. Plastic tries to use the "replication source" (origin of the replicated
  4146. branch)).
  4147. cm ^pull ^hydrate <dst_cs_spec> [<src_rep_spec>]
  4148. [--^user=<usr_name> [--^password=<pwd>] | AuthOptions]
  4149. (Introduces the missing data for a changeset previously replicated with
  4150. '--^nodata'. If a repo to obtain the data is not specified, Plastic tries to
  4151. use the "replication source").
  4152. src_br_spec The branch to pull from a remote repository.
  4153. (Use 'cm ^help ^objectspec' to learn more about branch specs.)
  4154. dst_br_spec The branch to hydrate.
  4155. (Use 'cm ^help ^objectspec' to learn more about branch specs.)
  4156. dst_cs_spec The changeset to hydrate.
  4157. (Use 'cm ^help ^objectspec' to learn more about changeset
  4158. specs.)
  4159. dst_rep_spec The destination repository.
  4160. (Use 'cm ^help ^objectspec' to learn more about repository
  4161. specs.)
  4162. --^package Specifies the previously created package file to import
  4163. for package based replication.
  4164. Useful to move data between servers when there is no
  4165. direct network connection.
  4166. Refer to 'cm ^push' to create a package file.
  4167. Options:
  4168. --^preview Gives information about what changes will be pulled but
  4169. no changes are actually performed. This option is useful
  4170. to check the data that will be transferred before
  4171. replicating changes.
  4172. --^nodata Replicates the branch changes without replicating the
  4173. data. This option is not allowed with package
  4174. replication.
  4175. TranslateOptions See the Translate options section for more information.
  4176. --^user, --^password Credentials to use if the authentication mode is
  4177. different in source and destination and there is not a
  4178. profile to authenticate to destination.
  4179. AuthOptions See the Authentication options section for more
  4180. information.
  4181. Translate options:
  4182. --^trmode=(^copy|^name|^table --^trtable=<translation_table_file>)
  4183. The source and destination repositories may use different authentication
  4184. modes. The '--^trmode' option specifies how to translate the user names from
  4185. the source to the destination. The '--^trmode' must be one of the following
  4186. values:
  4187. ^copy (Default). Means that the user identifiers will be just copied.
  4188. ^name The user identifiers will be matched by name.
  4189. ^table Uses a translation table specified in the option '--^trtable'
  4190. (see below).
  4191. --^trtable=<translation_table_file>
  4192. If the translation mode is 'table', a translation table is a file
  4193. containing lines in the form <oldname;newname> (one per line). When the
  4194. branch is written to the destination repository, the objects created by
  4195. a user identified by "oldname" in the source repository will be set
  4196. to the user with "newname" on the destination.
  4197. Authentication options:
  4198. Authentication data can be specified using one of the two following modes:
  4199. 1) Using authentication parameters: --^authmode=<mode> --^authdata=<data>
  4200. --^authmode=(^NameWorkingMode|^LDAPWorkingMode|^ADWorkingMode|^UPWorkingMode)
  4201. Examples:
  4202. (^LDAPWorkingMode) --^authdata=::0:dave:fPBea2rPsQaagEW3pKNveA
  4203. (^UPWorkingMode) --^authdata=dave:fPBea2rPsQaagEW3pKNveA==
  4204. The '--^authdata' line is the content of the <^SecurityConfig> entry
  4205. in the client.conf file and the profiles.conf file. The profiles.conf
  4206. file can be easily generated from the Plastic GUI in the replication
  4207. profiles tab under Preferences.
  4208. If you are using ^UPWorkingMode, you can simply specify:
  4209. --^authmode=^UPWorkingMode --^user=<user> --^password=<psw>
  4210. 2) Authentication file where you may have a different file for each server
  4211. you connect to, containing the credentials for that server.
  4212. --^authfile=<authentication_file>
  4213. The file contains 2 lines:
  4214. Line 1) mode, as described in '--^authmode'
  4215. Line 2) authentication data, as described in '--^authdata'
  4216. == CMD_HELP_PULL ==
  4217. Remarks:
  4218. The '^pull' command is able to replicate branches (along with their
  4219. changesets) between a source repository and a destination repository.
  4220. The repositories can be located at different servers.
  4221. There are two replication operations: '^push' and '^pull'.
  4222. A '^pull' operation means that the replication operation will demand data
  4223. from the source repository to be stored into the destination repository.
  4224. The client will connect to the destination repository and, from that host,
  4225. it will establish a connection to the source repository to retrieve the
  4226. targeted data. During pull it is the destination server which will be
  4227. connected to the source.
  4228. Although in a typical distributed scenario a developer pushes data from his
  4229. local server to the main server, the developer might want to pull the latest
  4230. repository updates from the main server, too.
  4231. Replication can resolve situations where concurrent changes have been made
  4232. on the same branch on two replicated repositories:
  4233. - Push: If you try to push your data to a repository having newer changes
  4234. than those you are sending, the system will ask you to pull the latest
  4235. changes, resolve the merge operation and, finally, try to push again.
  4236. - Pull: Whenever you pull changesets from a remote branch, they will be
  4237. correctly linked to their parent changesets. If the changeset you pulled
  4238. is not a child of the last changeset in the branch, then a multi-headed
  4239. scenario will appear. The branch will have more than one 'head', or last
  4240. changeset on the branch. You will need to merge the two 'heads' before
  4241. being able to push again.
  4242. Pull can work in two modes:
  4243. 1) Direct communication between servers: The destination server will fetch
  4244. the data from the source server, automatically synchronizing data for
  4245. the specified branch.
  4246. 2) Import a previously generated package with push and the '--^package' option.
  4247. Mode 1) requires the user running the command to be authenticated
  4248. by the remote server, either using the default authentication in the
  4249. client.conf file, or specifiying the '--^authmode' and '--^authdata' modifiers,
  4250. or '--^authmode' and '--^user' and '--^password' if the authentication mode is
  4251. ^UPWorkingMode.
  4252. Mode 2) requires using a package file previously generated with the push
  4253. command.
  4254. Keep in mind that pull replication works in an indirect way. When executed,
  4255. the command asks the destination repository to connect to the source and
  4256. obtain the selected branch.
  4257. However, this can be done directly by using the push command.
  4258. This will make the command replicate the selected branch from source to
  4259. destination.
  4260. Examples:
  4261. cm ^pull ^br:/main@project1@remoteserver:8084 projectx@myserver:8084
  4262. (Pulls the 'main' branch from 'remoteserver' to 'myserver'. In this case,
  4263. both servers are configured with the same authentication mode.)
  4264. cm ^pull ^br:/main@project1@remoteserver:8084 projectx@myserver:8084 \
  4265. --^authmode=^LDAPWorkingMode --^authdata=::0:dave:fPBea2rPsQaagEW3pKNveA
  4266. (Pulls the same branch as before, but now the remote server is configured
  4267. to authenticate users with Active Directory. For instance, I am connecting
  4268. from a Linux machine to a Windows server configured to use Active Directory
  4269. integrated mode. I will specify my Active Directory user and cyphered
  4270. password and pass it as LDAP to the server.)
  4271. cm ^pull ^br:/main@project1@remoteserver:8084 projectx@myserver:8084 \
  4272. --^authmode=^UPWorkingMode --^user=dave --^password=mysecret
  4273. (Pulls the same branch, but now users are authenticated on the remote
  4274. server, taking advantage of the user/password database included in
  4275. Plastic SCM.)
  4276. cm ^pull ^br:/main@project1@remoteserver:8084 projectx@myserver:8084 --^nodata
  4277. (Replicates the 'main' branch from 'remoteserver' to 'myserver' without data.)
  4278. cm ^pull ^hydrate ^br:/main@projectx@myserver:8084 projectx@remoteserver:8084
  4279. (Hydrates all the changesets in the 'main' branch obtaining the data from
  4280. the remote server.)
  4281. cm ^pull ^hydrate ^cs:122169@projectx@myserver:8084 projectx@remoteserver:8084
  4282. (Hydrates changeset 122169 in 'myserver' obtaining the data from the remote
  4283. server.)
  4284. == CMD_DESCRIPTION_PUSH ==
  4285. Pushes a branch to another repo.
  4286. == CMD_USAGE_PUSH ==
  4287. Usage:
  4288. cm ^push <src_br_spec> <dst_rep_spec>
  4289. [--^preview] [TranslateOptions]
  4290. [--^user=<usr_name> [--^password=<pwd>] | AuthOptions]
  4291. (Direct server-to-server replication. Pushes a branch from a repository.)
  4292. cm ^push <src_br_spec> --^package=<pack_file> [AuthOptions]
  4293. (Package based replication. Creates a replication package in the source
  4294. server with the selected branch.)
  4295. src_br_spec The branch to push to a remote repository.
  4296. (Use 'cm ^help ^objectspec' to learn more about branch specs.)
  4297. dst_rep_spec The destination repository.
  4298. (Use 'cm ^help ^objectspec' to learn more about repository
  4299. specs.)
  4300. --^package Specifies path for exporting replication package for
  4301. package based replication.
  4302. Useful to move data between servers when there is no
  4303. direct network connection.
  4304. Options:
  4305. --^preview Gives information about what changes will be pushed,
  4306. but no changes are actually performed. This option is
  4307. useful to check the data that will be transferred before
  4308. replicating changes.
  4309. TranslateOptions See the Translate options section for more information.
  4310. --^user, --^password Credentials to use if the authentication mode is
  4311. different in source and destination and there is not a
  4312. profile to authenticate to destination.
  4313. AuthOptions See the Authentication options section for more
  4314. information.
  4315. Translate options:
  4316. --^trmode=(^copy|^name|^table --^trtable=<translation_table_file>)
  4317. The source and destination repositories may use different authentication
  4318. modes. The '--^trmode' option specifies how to translate the user names
  4319. from the source to the destination. The '--^trmode' must be one of the
  4320. following values:
  4321. ^copy (Default). Means that the user identifiers will be just copied.
  4322. ^name The user identifiers will be matched by name.
  4323. ^table Uses a translation table specified in the option '--^trtable'
  4324. (see below).
  4325. --^trtable=<translation_table_file>
  4326. If the translation mode is 'table', a translation table is a file
  4327. containing lines in the form <oldname;newname> (one per line). When the
  4328. branch is written to the destination repository, the objects created by
  4329. a user identified by "oldname" in the source repository will be set
  4330. to the user with "newname" on the destination.
  4331. Authentication options:
  4332. Authentication data can be specified using one of the two following modes:
  4333. 1) Using authentication parameters: --^authmode=<mode> --^authdata=<data>
  4334. --^authmode=(^NameWorkingMode|^LDAPWorkingMode|^ADWorkingMode|^UPWorkingMode)
  4335. Examples:
  4336. (^LDAPWorkingMode) --^authdata=::0:dave:fPBea2rPsQaagEW3pKNveA
  4337. (^UPWorkingMode) --^authdata=dave:fPBea2rPsQaagEW3pKNveA==
  4338. The '--^authdata' line is the content of the <^SecurityConfig> entry
  4339. in the client.conf file and the profiles.conf file. The profiles.conf
  4340. file can be easily generated from the Plastic GUI in the replication
  4341. profiles tab under Preferences.
  4342. If you are using ^UPWorkingMode, you can simply specify:
  4343. --^authmode=^UPWorkingMode --^user=<user> --^password=<psw>
  4344. 2) Authentication file where you may have a different file for each server
  4345. you connect to, containing the credentials for that server.
  4346. --^authfile=<authentication_file>
  4347. The file contains 2 lines:
  4348. Line 1) mode, as described in '--^authmode'
  4349. Line 2) authentication data, as described in '--^authdata'
  4350. == CMD_HELP_PUSH ==
  4351. Remarks:
  4352. The '^push' command is able to replicate branches (along with their
  4353. changesets) between a source repository and a destination repository.
  4354. The repositories can be located at different servers.
  4355. There are two replication operations: '^push' and '^pull'.
  4356. A '^push' operation means that the replication operation will send data
  4357. from the source repository to the destination repository. In this case,
  4358. the client will connect to the source repository, getting the data to
  4359. replicate, and then it will send it to the destination repository. While
  4360. the former (source) must have connectivity to the destination, the latter
  4361. (destination) will not connect itself to the source.
  4362. In a typical distributed scenario, a developer pushes data from his local
  4363. server to the main server. Also, the developer might want to pull the latest
  4364. repository updates from the main server, too.
  4365. Replication can resolve situations where concurrent changes have
  4366. been made on the same branch on two replicated repositories.
  4367. - Push: If you try to push your data to a repository having newer changes
  4368. than those you are sending, the system will ask you to pull the latest
  4369. changes, resolve the merge operation and, finally, try to push again.
  4370. - Pull: Whenever you pull changesets from a remote branch, they will be
  4371. correctly linked to their parent changesets. If the changeset you pulled
  4372. is not a child of the last changeset in the branch, then a multi-headed
  4373. scenario will appear. The branch will have more than one 'head', or last
  4374. changeset on the branch. You will need to merge the two 'heads' before
  4375. being able to push again.
  4376. Push can work in two modes:
  4377. 1) Direct communication between servers: The origin server will send
  4378. the data to the destination server, automatically synchronizing data
  4379. for the specified branch.
  4380. 2) Export package mode: The client will only connect to the source and
  4381. generate a replication package obtaining both data and metadata for the
  4382. specified branch. The '--^package' modifier will be used.
  4383. Both modes require the user running the command to be authenticated
  4384. by the server, either using the default authentication in the client.conf
  4385. file, or specifiying the '--^authmode' and '--^authdata' modifiers.
  4386. The ^push replication works in a direct way. When executed, the command
  4387. will replicate the selected branch from source to destination, instead of
  4388. asking the destination repository to connect to the source and obtain the
  4389. selected branch (as the pull does).
  4390. Examples:
  4391. cm ^push ^br:/main@project1@myserver:8084 projectx@remoteserver:8084
  4392. (Replicates the 'main' branch from 'myserver' to 'remoteserver'. In this case,
  4393. both servers are configured with the same authentication mode.)
  4394. cm ^push ^br:/main@project1@myserver:8084 projectx@remoteserver:8084 \
  4395. --^authmode=^LDAPWorkingMode --^authdata=::0:dave:fPBea2rPsQaagEW3pKNveA
  4396. (Replicates same branch as before, but now the remote server is configured
  4397. to authenticate users with Active Directory. For instance, I am connecting
  4398. from a Linux machine to a Windows server configured to use Active Directory
  4399. integrated mode. I will specify my Active Directory user and cyphered
  4400. password and pass it as LDAP to the server.)
  4401. cm ^push ^br:/main@project1@myserver:8084 projectx@remoteserver:8084 \
  4402. --^authmode=^UPWorkingMode --^user=dave --^password=mysecret
  4403. (Replicates the same branch, but now users are authenticated on the remote
  4404. server, taking advantage of the user/password database included in
  4405. Plastic SCM.)
  4406. == CMD_DESCRIPTION_CLONE ==
  4407. Clones a remote repository.
  4408. == CMD_USAGE_CLONE ==
  4409. Usage:
  4410. cm ^clone <src_rep_spec> [<dst_rep_spec> | <dst_repserver_spec>]
  4411. [--^user=<usr_name> [--^password=<pwd>] | AuthOptions]
  4412. [TranslateOptions]
  4413. (Direct repository-to-repository clone.)
  4414. cm ^clone <src_rep_spec> --^package=<pack_file>
  4415. [--^user=<usr_name> [--^password=<pwd>] | AuthOptions]
  4416. (Clones to an intermediate package, that can be imported later using a
  4417. pull into the destination repository.)
  4418. src_rep_spec Source repository of the clone operation.
  4419. (Use 'cm ^help ^objectspec' to learn more about repository
  4420. specs.)
  4421. dst_rep_spec Destination repository of the clone operation. If it
  4422. exists, it must be empty. If it does not exist, it will
  4423. be created.
  4424. If it is not specified, the command will use user's
  4425. default repository server.
  4426. (Use 'cm ^help ^objectspec' to learn more about repository
  4427. specs.)
  4428. dst_repserver_spec Destination repository server of the clone operation.
  4429. If there is a repository with the same name as
  4430. <src_rep_spec> in the destination repository server, it
  4431. must be empty. If there is not, it will be created.
  4432. If it is not specified, the command will use user's
  4433. default repository server.
  4434. (Use 'cm ^help ^objectspec' to learn more about repository
  4435. server specs.)
  4436. Options:
  4437. --^user, --^password Credentials to use if the authentication mode is
  4438. different in source and destination and there is not a
  4439. profile to authenticate to destination.
  4440. --^package Exports the specified repository to a package file,
  4441. instead of a repository.
  4442. Useful for moving data between servers when there is no
  4443. direct network connection.
  4444. The resulting package must be imported using the
  4445. pull command.
  4446. TranslateOptions See the Translate options section for more information.
  4447. AuthOptions See the Authentication options section for more
  4448. information.
  4449. Translate options:
  4450. --^trmode=(^copy|^name|^table --^trtable=<translation_table_file>)
  4451. The source and destination repositories may use different authentication
  4452. modes. The '--^trmode' option specifies how to translate the user names from
  4453. the source to the destination. The '--^trmode' must be one of the following
  4454. values:
  4455. ^copy (Default.) Means that the user identifiers will be just copied.
  4456. ^name The user identifiers will be matched by name.
  4457. ^table Uses a translation table specified in the option '--^trtable'
  4458. (see below).
  4459. --^trtable=<translation_table_file>
  4460. If the translation mode is 'table', a translation table is a file
  4461. containing lines in the form <oldname;newname> (one per line). When the
  4462. branch is written to the destination repository, the objects created by
  4463. a user identified by "oldname" in the source repository will be set
  4464. to the user with "newname" on the destination.
  4465. Authentication options:
  4466. Authentication data can be specified using one of the two following modes:
  4467. 1) Using authentication parameters: --^authmode=<mode> --^authdata=<data>
  4468. --^authmode=(^NameWorkingMode|^LDAPWorkingMode|^ADWorkingMode|^UPWorkingMode)
  4469. Examples:
  4470. (^LDAPWorkingMode) --^authdata=::0:dave:fPBea2rPsQaagEW3pKNveA
  4471. (^UPWorkingMode) --^authdata=dave:fPBea2rPsQaagEW3pKNveA==
  4472. The '--^authdata' line is the content of the <^SecurityConfig> entry
  4473. in the client.conf file and the profiles.conf file. The profiles.conf
  4474. file can be easily generated from the Plastic GUI in the connection
  4475. profiles tab under Preferences.
  4476. If you are using ^UPWorkingMode, you can simply specify:
  4477. --^authmode=^UPWorkingMode --^user=<user> --^password=<pwd>
  4478. 2) Authentication file where you may have a different file for each server
  4479. you connect to, containing the credentials for that server.
  4480. --^authfile=<authentication_file>
  4481. The file contains 2 lines:
  4482. Line 1) mode, as described in '--^authmode'
  4483. Line 2) authentication data, as described in '--^authdata'
  4484. == CMD_HELP_CLONE ==
  4485. Remarks:
  4486. The clone command can replicate branches (along with their changesets,
  4487. labels, attributes, reviews, and so on) from a source repository to a
  4488. destination repository. The repositories can be located at different servers.
  4489. The destination repository can be created beforehand, but if it contains
  4490. previous data, the clone operation will fail.
  4491. The clone operation does NOT clone repository submodules, nor repositories
  4492. under a Xlink.
  4493. Examples:
  4494. cm ^clone awesomeProject@tardis@cloud
  4495. (Clones 'awesomeProject' repository from 'tardis@cloud' organization into
  4496. a local repository with the same name.)
  4497. cm ^clone repo@server.home:9095 repo-local
  4498. (Clones 'repo' from 'server.home:9095' into 'repo-local' at user's default
  4499. repository server.)
  4500. cm ^clone project@192.168.111.130:8084 ^repserver:192.168.111.200:9095
  4501. (Clones 'project' repository from '192.168.111.130:8084' into
  4502. 'project@192.168.111.200:9095'.)
  4503. cm ^clone project@ldapserver:8084 --authfile=credentials.txt \
  4504. --^trmode=table --^trtable=table.txt
  4505. (Clones 'project' repository from 'ldapserver:8084' using an authentication
  4506. file against the remote repository, and translating users following the
  4507. specified translation table.)
  4508. cm ^clone project@server.home:9095 --^package=project.plasticpkg
  4509. cm ^repository ^create project@mordor.home:8084
  4510. cm ^pull --^package=project.plasticpkg project@mordor.home:8084
  4511. (Clones 'project' repository from 'server.home:9095' into the package
  4512. 'project.plasticpkg', which is later imported through a pull into
  4513. the 'project' repository at 'mordor.home:8084'.)
  4514. == CMD_DESCRIPTION_REVERT ==
  4515. Reverts an item to a previous revision.
  4516. == CMD_USAGE_REVERT ==
  4517. Usage:
  4518. cm ^revert <revspec>
  4519. revspec Specification of the changeset that contains the
  4520. revision which content will be loaded in the workspace.
  4521. (Use 'cm ^help ^objectspec' to learn more about revision
  4522. specs.)
  4523. == CMD_HELP_REVERT ==
  4524. Remarks:
  4525. The item must be checked in.
  4526. Examples:
  4527. cm ^revert dir#^cs:0
  4528. cm ^revert C:\mywks\dir\file1.txt#23456
  4529. == CMD_DESCRIPTION_REVISION_HISTORY ==
  4530. Displays the history of a file or directory.
  4531. == CMD_USAGE_REVISION_HISTORY ==
  4532. Usage:
  4533. cm ^history | ^hist <item_path>[ ...] [--^long | --^format=<str_format>]
  4534. [--^symlink] [--^xml[=<output_file>]] [--^encoding=<name>]
  4535. [--^moveddeleted]
  4536. item_path Item's path. Use a whitespace to separate paths. Use
  4537. double quotes (" ") to specify paths containing spaces.
  4538. Paths can be server path revisions too.
  4539. (Use 'cm ^help ^objectspec' to learn more about specs.)
  4540. Options:
  4541. --^long Shows additional information.
  4542. --^format Retrieves the output message in a specific format. See
  4543. Remarks for more info. This option cannnot be combined
  4544. with '--^xml'.
  4545. --^symlink Applies the history operation to the symlink and not to
  4546. the target.
  4547. --^xml Prints the output in XML format to the standard output.
  4548. It is possible to specify an output file. This option
  4549. cannot be combined with '--^format'.
  4550. --^encoding Used with the '--^xml' option, specifies the encoding to
  4551. use in the XML output, i.e.: utf-8.
  4552. See the MSDN documentation at
  4553. http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx
  4554. to get the table of supported encodings and its format,
  4555. (at the end of the page, in the "Name" column).
  4556. --^moveddeleted Include move and remove operations in the history.
  4557. --^limit Displays the N most recent revisions for the specified items,
  4558. sorted by date and changeset id. If a negative number is supplied,
  4559. it will return an empty list. If a number higher than the number
  4560. of revisions is supplied, it will return all the available revisions
  4561. regarding that item.
  4562. == CMD_HELP_REVISION_HISTORY ==
  4563. Remarks:
  4564. This command shows a list of revisions for a given item, and label, branch,
  4565. and comment info for each revision.
  4566. Output format parameters (--^format option):
  4567. This command accepts a format string to show the output.
  4568. The output parameters of this command are the following:
  4569. {0} | {^date} Date.
  4570. {1} | {^changesetid} Changeset number.
  4571. {2} | {^branch} Branch.
  4572. {4} | {^comment} Comment.
  4573. {5} | {^owner} Owner.
  4574. {6} | {^id} Revision id.
  4575. {7} | {^repository} Repository.
  4576. {8} | {^server} Server.
  4577. {9} | {^repspec} Repository spec.
  4578. {10}| {^datastatus} Availability of the revision data.
  4579. {11}| {^path} Path or spec passed as <item_path>.
  4580. {12}| {^itemid} Item Id.
  4581. {13}| {^size} Size.
  4582. {14}| {^hash} Hash code.
  4583. {^tab} Inserts a tab space.
  4584. {^newline} Inserts a new line.
  4585. Examples:
  4586. cm ^history file1.txt "file 2.txt"
  4587. cm ^hist c:\workspace --^long
  4588. (Displays all information.)
  4589. cm ^history link --^symlink
  4590. (Applies the history operation to the symlink file and not to the target.)
  4591. cm ^history ^serverpath:/src/foo/bar.c#^br:/main/task001@myserver
  4592. (Retrieves the revision history from a server path in a given branch.)
  4593. cm ^history bar.c, foo.c --long --limit=2
  4594. (Retrieves the 2 last revisions for the bar.c and foo.c items.)
  4595. == CMD_DESCRIPTION_REVISION_TREE ==
  4596. Shows the revision tree for an item.
  4597. == CMD_USAGE_REVISION_TREE ==
  4598. Usage:
  4599. cm ^tree <path> [--^symlink]
  4600. path Item path.
  4601. Options:
  4602. --^symlink Applies the operation to the link file and not to the target.
  4603. == CMD_HELP_REVISION_TREE ==
  4604. Examples:
  4605. cm ^tree fichero1.txt
  4606. cm ^tree c:\workspace
  4607. cm ^tree link --^symlink
  4608. (Applies the operation to the symlink file and not to the target.)
  4609. == CMD_DESCRIPTION_RM ==
  4610. Allows the user to delete files and directories.
  4611. == CMD_USAGE_RM ==
  4612. Usage:
  4613. cm ^remove | ^rm <command> [options]
  4614. Commands:
  4615. ^controlled (optional)
  4616. ^private
  4617. To get more information about each command run:
  4618. cm ^remove <command> --^usage
  4619. cm ^remove <command> --^help
  4620. == CMD_HELP_RM ==
  4621. Examples:
  4622. cm ^remove \path\controlled_file.txt
  4623. cm ^remove ^private \path\private_file.txt
  4624. == CMD_DESCRIPTION_RM_CONTROLLED ==
  4625. Deletes a file or directory from version control.
  4626. == CMD_USAGE_RM_CONTROLLED ==
  4627. Usage:
  4628. cm ^remove | ^rm <item_path>[ ...] [--^format=<str_format>]
  4629. [--^errorformat=<str_format>] [--^nodisk]
  4630. item_path Items path to remove. Use double quotes (" ") to specify
  4631. paths containing spaces. Use a whitespace to separate
  4632. paths.
  4633. Options:
  4634. --^format Retrieves the output progress message in a specific
  4635. format. See the Examples for more information.
  4636. --^errorformat Retrieves the error message (if any) in a specific
  4637. format. See the Examples for more information.
  4638. --^nodisk Removes from version control, but keeps the item on
  4639. disk.
  4640. == CMD_HELP_RM_CONTROLLED ==
  4641. Remarks:
  4642. Items are deleted from disk. Removed items are removed from the parent
  4643. directory in the source code control.
  4644. Requirements:
  4645. - The item must be under source code control.
  4646. Reading input from stdin:
  4647. The '^remove' command can read paths from stdin. To do this, pass a single
  4648. dash "-".
  4649. Example: cm ^remove -
  4650. Paths will be read until an empty line is entered.
  4651. This allows you to use pipe to specify which files to remove.
  4652. Example:
  4653. dir /S /B *.c | cm ^remove -
  4654. (In Windows, removes all .c files in the workspace.)
  4655. Examples:
  4656. cm ^remove src
  4657. (Removes 'src'. If src is a directory, this is the same as
  4658. 'cm ^remove -^R src'.)
  4659. cm ^remove c:\workspace\file.txt --^format="{0} - REMOVED" \
  4660. --^errorformat="{0} - ERROR REMOVING"
  4661. (Removes 'file.txt' from version control and from disk, writing
  4662. "c:\workspace\file.txt - ^REMOVED" if the operation succeeded, or
  4663. "c:\workspace\file.txt - ^ERROR ^REMOVING" otherwise.)
  4664. cm ^remove c:\workspace\file.txt --^nodisk
  4665. (Removes 'file.txt' from version control, but keeps it on disk.)
  4666. == CMD_DESCRIPTION_RM_PRIVATE ==
  4667. Deletes a private file or directory.
  4668. Warning: files deleted using the command are permanently erased, and are not
  4669. recoverable. It is recommended that you use the '--^dry-run' option to check
  4670. which files will be affected by the command.
  4671. == CMD_USAGE_RM_PRIVATE ==
  4672. Usage:
  4673. cm ^remove | ^rm ^private <path>[ ...] [-^R | -^r | --^recursive] [--^ignored]
  4674. [--^verbose] [--^dry-run]
  4675. path Path of the files or directories to remove. Use double
  4676. quotes (" ") to specify paths containing spaces. Use a
  4677. whitespace to separate paths.
  4678. Options:
  4679. --^r Recursively deletes private files from within controlled
  4680. directories.
  4681. --^ignored Deletes also ignored and cloaked files and directories.
  4682. --^verbose Prints all affected paths.
  4683. --^dry-run Runs the command without making any changes on disk.
  4684. == CMD_HELP_RM_PRIVATE ==
  4685. Remarks:
  4686. If the path is a private file or directory, it will be deleted from disk.
  4687. If the path is a controlled file, the command fails.
  4688. If the path is a controlled directory, the command fails unless you
  4689. specify the '-^r' option, in which case it will delete all private files and
  4690. directories below the specified directory.
  4691. Examples:
  4692. cm ^remove ^private private_directory
  4693. (Deletes 'private_directory'.)
  4694. cm ^remove ^private c:\workspace\controlled_directory
  4695. (Fails, because 'controlled_directory' is not private.)
  4696. cm ^remove ^private -^r c:\workspace\controlled_directory
  4697. (Deletes all private files and directories below 'controlled_directory'.)
  4698. cm ^rm ^private --^dry-run --^verbose c:\workspace\controlled_directory -^r
  4699. (Shows all of the paths affected by the deletion of private files below
  4700. 'controlled_directory' without actually deleting anything.)
  4701. cm ^rm ^private --^verbose c:\workspace\controlled_directory -^r
  4702. (Shows all of the paths affected by the deletion of private files below
  4703. 'controlled_directory', performing the delete.)
  4704. == CMD_DESCRIPTION_TRIGGER_DELETE ==
  4705. Deletes a trigger.
  4706. == CMD_USAGE_TRIGGER_DELETE ==
  4707. Usage:
  4708. cm ^trigger | ^tr ^delete | ^rm <subtype-type> <position_number>
  4709. [--^server=<repserverspec>]
  4710. subtype-type Trigger execution and trigger operation.
  4711. (Use 'cm ^showtriggertypes' to see a list of trigger
  4712. types.)
  4713. position_number Position assigned to the trigger when it was created.
  4714. Options:
  4715. --^server Deletes the trigger on the specified server.
  4716. If no server is specified, executes the command on the
  4717. one configured on the client.
  4718. == CMD_HELP_TRIGGER_DELETE ==
  4719. Examples:
  4720. cm ^trigger ^delete ^after-setselector 4
  4721. cm ^tr ^rm ^after-setselector 4
  4722. == CMD_DESCRIPTION_ATTRIBUTE_SET ==
  4723. Sets an attribute on a given object.
  4724. == CMD_USAGE_ATTRIBUTE_SET ==
  4725. Usage:
  4726. cm ^attribute | ^att ^set <att_spec> <object_spec> <att_value>
  4727. att_spec Attribute specification. (Use 'cm ^help ^objectspec' to
  4728. learn more about attribute specs.)
  4729. object_spec Specification of the object to set the attribute on.
  4730. Attributes can be set on: branches, changesets,
  4731. shelvesets, labels, items, and revisions.
  4732. (Use 'cm ^help ^objectspec' to learn more about specs.)
  4733. att_value The attribute value to set to the object.
  4734. == CMD_HELP_ATTRIBUTE_SET ==
  4735. Remarks:
  4736. An attribute can be set on an object to save additional information for
  4737. this object.
  4738. Attributes can be set on the following objects: branches, changesets,
  4739. shelvesets, labels, items, and revisions.
  4740. Examples:
  4741. cm ^attribute ^set ^att:status ^br:/main/SCM105 open
  4742. (Sets attribute 'status' to branch 'SCM105' with value 'open'.)
  4743. cm ^att ^set ^att:integrated@reptest@server2:8084 ^lb:LB008@reptest@server2:8084 yes
  4744. (Sets attribute 'integrated' to label 'LB008' in repository 'reptest' with
  4745. value 'yes'.)
  4746. == CMD_DESCRIPTION_SETOWNER ==
  4747. Sets the owner of an object.
  4748. == CMD_USAGE_SETOWNER ==
  4749. Usage:
  4750. cm ^setowner | ^sto --^user=<usr_name> | --^group=<group> <object_spec>
  4751. --^user User name. New owner of the object.
  4752. --^group Group name. New owner of the object.
  4753. object_spec Specification of the object to set the new owner on.
  4754. The owner can be set on the following objects:
  4755. repository server, repository, branch, changeset,
  4756. label, item, revision and attribute.
  4757. (Use 'cm ^help ^objectspec' to learn more about specs.)
  4758. == CMD_HELP_SETOWNER ==
  4759. Remarks:
  4760. The owner of an object can be a user or a group.
  4761. The owner can be set on the following objects: repository server,
  4762. repository, branch, changeset, label, item, revision, and attribute.
  4763. Examples:
  4764. cm ^setowner --^user=john ^repserver:localhost:8084
  4765. (Sets 'john' as repository server owner.)
  4766. cm ^sto --^group=development ^rep:mainRep@PlasticServer:8084
  4767. (Sets 'development' group as owner of 'mainRep' repository.)
  4768. == CMD_DESCRIPTION_SETSELECTOR ==
  4769. Sets the selector to a workspace.
  4770. == CMD_USAGE_SETSELECTOR ==
  4771. This command is deprecated. It is still present for backwards compatibility
  4772. but selectors were largely deprecated in Plastic SCM 4.0. Selectors still
  4773. exist to specify the working branch or changeset, but the old rules to
  4774. filter paths are no longer supported.
  4775. Usage:
  4776. cm ^setselector | ^sts [--^file=<selector_file>] [--^ignorechanges]
  4777. [--^forcedetailedprogress] [<wk_path> | <wk_spec>]
  4778. Options:
  4779. --^file File to load a selector from.
  4780. --^ignorechanges Ignores the pending changes warning message that is
  4781. shown if there are pending changes detected when
  4782. updating the workspace.
  4783. --^forcedetailedprogress Forces detailed progress even when standard output
  4784. is redirected.
  4785. wk_path Path of the workspace to set the selector.
  4786. wk_spec Workspace specification. (Use 'cm ^help ^objectspec'
  4787. to learn more about workspace specs.)
  4788. == CMD_HELP_SETSELECTOR ==
  4789. Remarks:
  4790. This command sets the selector of a workspace.
  4791. A workspace needs information to load revisions from the repository.
  4792. To get this information, Plastic SCM uses a selector.
  4793. Using a selector, it is possible to load revisions from a given branch,
  4794. label, or changeset.
  4795. If a file to load the selector is not specified, the default Operating
  4796. System editor will be executed.
  4797. Sample selector:
  4798. ^repository "^default" // working repository
  4799. ^path "/" // rules will be applied to the root directory
  4800. ^branch "/^main" // obtain latest revisions from ^br:/^main
  4801. ^checkout "/^main" // place checkouts on branch ^br:/^main
  4802. Examples:
  4803. cm ^sts
  4804. (Opens the current selector file to be applied.)
  4805. cm ^sts ^wk:workspace_projA@reptest
  4806. (Opens the specified selector file to be applied.)
  4807. cm ^setselector --^file=c:\selectors\sel.xml
  4808. (Sets the specified selector file in the current workspace.)
  4809. cm ^setselector --^file=c:\selectors\sel.xml ^wk:MyWorkspace
  4810. (Sets the specified selector file in the selected workspace.)
  4811. == CMD_DESCRIPTION_SHELVE ==
  4812. Shelves the contents of checked-out items.
  4813. == CMD_USAGE_SHELVE ==
  4814. This command is deprecated. Use 'cm ^shelveset' instead.
  4815. Usage:
  4816. cm ^shelve [<item_path>+] [--^all] [--^dependencies]
  4817. [-^c=str_comment | -^commentsfile=<comments_file>]
  4818. [--^encoding=name] [--^comparisonmethod=comp_method]
  4819. (Shelves the contents.)
  4820. cm ^shelve --^apply=<sh_spec> [--^mount]
  4821. (Applies a stored shelveset.)
  4822. --^apply Restores the shelved contents of the specified shelveset.
  4823. Shelve specification: check 'cm ^help ^objectspec'.
  4824. cm ^shelve --^delete=<sh_spec>
  4825. (Removes a stored shelveset.)
  4826. --^delete Removes the specified shelveset.
  4827. Shelveset specification: check 'cm ^help ^objectspec'.
  4828. Options:
  4829. item_path Items to be shelved, separated by spaces. Quotes (") can
  4830. be used to specify paths containing spaces.
  4831. --^all The items changed, moved and deleted locally, on the
  4832. given paths, will also be included.
  4833. --^dependencies Includes local change dependencies in the items to
  4834. shelve.
  4835. -^c Applies the specified comment to the created shelveset.
  4836. -^commentsfile Applies the comment in the specified file to the created
  4837. shelveset.
  4838. --^encoding Specifies the output encoding, i.e.: utf-8.
  4839. See the MSDN documentation at
  4840. http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx
  4841. to get the table of supported encodings and its format,
  4842. (at the end of the page, in the "Name" column).
  4843. --^comparisonmethod Sets the comparison method. See remarks for more info.
  4844. --^mount The mount point for the given repository.
  4845. == CMD_HELP_SHELVE ==
  4846. Remarks:
  4847. If neither <item_path> nor any option is specified, the shelve will involve
  4848. all the pending changes in the workspace.
  4849. The shelve operation is always applied recursively from the given path.
  4850. Requirements to shelve an item:
  4851. - The item must be under source code control.
  4852. - The item must be checked out or changed (--^all option must be used).
  4853. Comparison methods:
  4854. ^ignoreeol Ignores end of line differences.
  4855. ^ignorewhitespaces Ignores whitespace differences.
  4856. ^ignoreeolandwhitespaces Ignores end of line and whitespace differences.
  4857. ^recognizeall Detects end of line and whitespace differences.
  4858. Set the PLASTICEDITOR environment variable to specify an editor for
  4859. entering comments. If the PLASTICEDITOR environment variable is set, and
  4860. the comment is empty, the editor will be automatically launched to allow
  4861. you to specify the comment.
  4862. Examples:
  4863. cm ^shelve -^c="my comment"
  4864. (Shelves all the pending changes in the current workspace including a
  4865. comment.)
  4866. cm ^shelve file1.txt "file 2.txt" -^commentsfile=commentshelve.txt
  4867. (Shelves the selected pending changes and applies the comment in the
  4868. commentshelve.txt file.)
  4869. cm ^shelve --^apply=^sh:3
  4870. (Applies a stored shelveset.)
  4871. cm ^shelve --^delete=^sh:3
  4872. (Removes a stored shelveset.)
  4873. cm ^status --^short --^changelist=pending_to_review | cm ^shelve -
  4874. (Shelves client changelist.
  4875. The command above lists the paths in the changelist named
  4876. 'pending_to_review' and the path list is redirected to the input of the
  4877. shelve command.)
  4878. == CMD_DESCRIPTION_SHELVESET ==
  4879. Allows the user to manage shelvesets.
  4880. == CMD_USAGE_SHELVESET ==
  4881. Usage:
  4882. cm ^shelveset <command> [options]
  4883. Commands:
  4884. ^create | ^mk
  4885. ^delete | ^rm
  4886. ^apply
  4887. To get more information about each command run:
  4888. cm ^shelveset <command> --^usage
  4889. cm ^shelveset <command> --^help
  4890. == CMD_HELP_SHELVESET ==
  4891. Examples:
  4892. cm ^shelveset ^create -^c="my comment"
  4893. cm ^shelveset ^delete ^sh:3
  4894. cm ^shelve ^apply ^sh:3
  4895. == CMD_DESCRIPTION_SHELVESET_CREATE ==
  4896. Shelves pending changes.
  4897. == CMD_USAGE_SHELVESET_CREATE ==
  4898. Usage:
  4899. cm ^shelveset ^create | ^mk [<item_path>[ ...]] [--^all] [--^dependencies]
  4900. [-^c=<str_comment> | -^commentsfile=<comments_file>]
  4901. Options:
  4902. item_path Items to shelve. Use a whitespace to separate user names.
  4903. Use double quotes (" ") to specify paths containing
  4904. spaces.
  4905. --^all The items changed, moved, and deleted locally, on the
  4906. given paths, will also be included.
  4907. --^dependencies Includes local change dependencies into the items to
  4908. shelve.
  4909. -^c Applies the specified comment to the created shelve.
  4910. -^commentsfile Applies the comment in the specified file to the created
  4911. shelve.
  4912. == CMD_HELP_SHELVESET_CREATE ==
  4913. The '^shelveset ^create' command stores the contents of checked out items inside the
  4914. repository. This way the contents are protected without the need to
  4915. checkin the files.
  4916. Remarks:
  4917. If neither <item_path> nor any option is specified, the shelveset will
  4918. include all the pending changes in the workspace.
  4919. The '^shelveset ^create' operation is always applied recursively from the
  4920. given path.
  4921. Requirements to shelve an item:
  4922. - The item must be under source code control.
  4923. - The item must be checked out or changed ('--^all' option must be used).
  4924. Set the PLASTICEDITOR environment variable to specify an editor for
  4925. entering comments. If the PLASTICEDITOR environment variable is set, and
  4926. the comment is empty, the editor will be automatically launched to allow
  4927. you to specify the comment.
  4928. Examples:
  4929. cm ^shelveset ^create -^c="my comment"
  4930. (Shelves all the pending changes in the current workspace including a
  4931. comment.)
  4932. cm ^shelveset file1.txt "file 2.txt" -^commentsfile=commentshelve.txt
  4933. (Shelves the selected pending changes and applies the comment in the
  4934. 'commentshelve.txt' file. Note, '^create' is the default subcommand.)
  4935. cm ^status --^short --^changelist=pending_to_review | cm ^shelveset -
  4936. (Shelves client changelist.
  4937. The command above lists the paths in the changelist named
  4938. 'pending_to_review' and the path list is redirected to the input of the
  4939. '^shelveset' command.)
  4940. == CMD_DESCRIPTION_SHELVESET_DELETE ==
  4941. Deletes a shelveset.
  4942. == CMD_USAGE_SHELVESET_DELETE ==
  4943. Usage:
  4944. cm ^shelveset ^delete | ^rm <sh_spec>
  4945. sh_spec Shelveset specification. (Use 'cm ^help ^objectspec' to
  4946. learn more about shelveset specs.)
  4947. == CMD_HELP_SHELVESET_DELETE ==
  4948. The '^shelveset ^delete' command deletes a shelveset.
  4949. Examples:
  4950. cm ^shelveset ^delete ^sh:3
  4951. (Removes a stored shelveset.)
  4952. == CMD_DESCRIPTION_SHELVESET_APPLY ==
  4953. Applies a stored shelveset.
  4954. == CMD_USAGE_SHELVESET_APPLY ==
  4955. Usage:
  4956. cm ^shelveset ^apply <sh_spec> [<change_path>[ ...]] [--^preview]
  4957. [--^mount] [--^encoding=<name>]
  4958. [--^comparisonmethod=(^ignoreeol | ^ignorewhitespaces| \
  4959. ^ignoreeolandwhitespaces | ^recognizeall)]
  4960. sh_spec Shelveset specification. (Use 'cm ^help ^objectspec' to
  4961. learn more about shelveset specs.)
  4962. change_path The change path(s) of the shelve to apply. It's a
  4963. server path, the one printed by the --preview option.
  4964. When no path is set, all changes will be applied.
  4965. Options:
  4966. --^preview Prints the changes to apply on the workspace without
  4967. applying them
  4968. --^mount The mount point for the given repository.
  4969. --^encoding Specifies the output encoding, i.e.: utf-8.
  4970. See the MSDN documentation at
  4971. http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx
  4972. to get the table of supported encodings and its format,
  4973. (at the end of the page, in the "Name" column).
  4974. --^comparisonmethod Sets the comparison method. See Remarks for more info.
  4975. == CMD_HELP_SHELVESET_APPLY ==
  4976. The '^shelveset ^apply' command restores the contents of a stored shelveset.
  4977. Remarks:
  4978. Comparison methods:
  4979. ^ignoreeol Ignores end of line differences.
  4980. ^ignorewhitespaces Ignores whitespace differences.
  4981. ^ignoreeolandwhitespaces Ignores end of line and whitespace differences.
  4982. ^recognizeall Detects end of line and whitespace differences.
  4983. Examples:
  4984. cm ^shelveset ^apply ^sh:3
  4985. (Applies a stored shelve.)
  4986. cm ^shelveset ^apply ^sh:3 /src/foo.c
  4987. (Applies only the /src/foo.c change stored on the shelve.)
  4988. == CMD_DESCRIPTION_SHOW_FIND_OBJECTS ==
  4989. Lists objects and attributes.
  4990. == CMD_USAGE_SHOW_FIND_OBJECTS ==
  4991. Usage:
  4992. cm ^showfindobjects
  4993. == CMD_HELP_SHOW_FIND_OBJECTS ==
  4994. Available objects and attributes:
  4995. ^attribute:
  4996. You can find attributes by filtering using the following fields:
  4997. ^type : string.
  4998. Example:
  4999. cm ^find ^attribute "^where ^type = 'status'"
  5000. (Finds all attributes of type 'status'.)
  5001. ^value : string.
  5002. ^date : date.
  5003. Check "date constants" for more info in this guide.
  5004. Example:
  5005. cm ^find ^attribute "^where ^date > '^this ^week'"
  5006. (Finds all attributes applied during the current week.)
  5007. ^owner : user.
  5008. Admits special user '^me'.
  5009. Example:
  5010. cm ^find ^attribute "^where ^value = 'resolved' ^and ^owner = '^me'"
  5011. (Finds all attributes with value 'resolved' applied by me.)
  5012. ^GUID : Global Unique Identifier.
  5013. Hexadecimal id in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
  5014. ^comment : string.
  5015. ^srcobj : object spec: item path, branch, changeset, revision, or label.
  5016. Use 'cm ^help ^objectspec' to learn how to specify these objects.
  5017. Examples:
  5018. cm ^find ^attribute "^where ^srcobj = '^item:readme.txt'"
  5019. (Finds the attributes applied to the item 'readme.txt'.)
  5020. cm ^find ^attribute "^where ^srcobj = '^br:/main/scm23343'"
  5021. (Finds the attributes applied to the branch scm23343.)
  5022. cm ^find ^attribute "^where ^srcobj = '^rev:readme.txt#^br:/main/task002'"
  5023. (Finds the attributes applied to the specified revision.)
  5024. cm ^find ^attribute "^where ^srcobj = '^rev:^revid:1126'"
  5025. (Finds the attributes applied to the specified revision id.)
  5026. ^ID : integer.
  5027. ^attributetype:
  5028. You can find attribute types by filtering using the following fields:
  5029. ^name : string.
  5030. Example:
  5031. cm ^find ^attributetype "^where ^name ^like 'st%'"
  5032. (Finds all attribute where name starts with 'st'.)
  5033. ^value : string.
  5034. ^date : date.
  5035. Check "date constants" for more info in this guide.
  5036. Example:
  5037. cm ^find ^attribute "^where ^date > '^today'"
  5038. (Finds all attributes applied today.)
  5039. ^owner : user.
  5040. Admits special user '^me'.
  5041. ^GUID : Global Unique Identifier.
  5042. Hexadecimal id in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
  5043. ^comment : string.
  5044. Example:
  5045. cm ^find ^attributetype "^where ^comment != ''" --^xml
  5046. (Finds all attribute types that have a comment and prints the
  5047. output in XML format to the standard output.)
  5048. ^source : object spec: item path, branch, changeset or label.
  5049. Use 'cm ^help ^objectspec' to learn how to specify these objects.
  5050. Example:
  5051. cm ^find ^attributetype "^where ^source = '^item:readme.txt'"
  5052. (Finds all attribute types in item 'readme.txt'.)
  5053. cm ^find ^attributetype "^where ^source = '^cs:30'"
  5054. (Finds all attribute types in changeset '30'.)
  5055. cm ^find ^attributetype "^where ^source = '^lb:v0.14.1'"
  5056. (Finds all attribute types in label 'v0.14.1'.)
  5057. ^ID : integer.
  5058. Replication field. Check "replication related fields" below.
  5059. ^ReplLogId
  5060. ^ReplSrcDate
  5061. ^ReplSrcId
  5062. ^ReplSrcRepository
  5063. ^ReplSrcServer
  5064. ^branch:
  5065. You can find branches by filtering using the following fields:
  5066. ^name : string.
  5067. Example:
  5068. cm ^find ^branch "^where ^name ^like 'scm23%'"
  5069. (Finds branches which name starts with 'scm23'.)
  5070. ^date : date.
  5071. Check "date constants" for more info in this guide.
  5072. Example:
  5073. cm ^find ^branch "^where ^date > '^one ^week ^ago'"
  5074. (Finds branches created during the last week.)
  5075. ^changesets : date (of the changesets in the branch).
  5076. Check "date constants" for more info in this guide.
  5077. Example:
  5078. cm ^find ^branch "^where ^changesets >= '^today'"
  5079. (Finds branches with changesets created today.)
  5080. ^attribute : string.
  5081. ^attrvalue : string.
  5082. Example:
  5083. cm ^find ^branch "^where ^attribute = 'status' ^and ^attrvalue = 'failed'"
  5084. (Finds branches that have the attribute 'status' and which
  5085. value is 'failed'.)
  5086. ^owner : user.
  5087. Admits special user '^me'.
  5088. ^parent : branch spec.
  5089. Use 'cm ^help ^objectspec' to learn how to specify this object.
  5090. Example:
  5091. cm ^find ^branch "^where ^owner != '^me' ^and ^parent != '^br:/main'"
  5092. (Finds branches created by other than me and which parent
  5093. branch is not '/main'.)
  5094. ^comment : string.
  5095. ^GUID : Global Unique Identifier.
  5096. Hexadecimal id in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
  5097. ^ID : integer.
  5098. Example:
  5099. cm ^find ^branch "^where ^id = 2029607"
  5100. (Finds the branch which id is 2029607.)
  5101. You can use the '^order ^by' clause with this object. Specifically, you can short
  5102. by using the following fields:
  5103. ^date
  5104. ^branchname
  5105. Replication fields. Check "replication related fields" below.
  5106. ^ReplLogId
  5107. ^ReplSrcDate
  5108. ^ReplSrcId
  5109. ^ReplSrcRepository
  5110. ^ReplSrcServer
  5111. ^changeset:
  5112. You can find changesets by filtering using the following fields:
  5113. ^branch : branch spec.
  5114. Use 'cm ^help ^objectspec' to learn how to specify this
  5115. object.
  5116. Example:
  5117. cm ^find ^changeset "^where ^branch = '/main/scm23119'"
  5118. (Finds all changesets in branch 'scm23119'.)
  5119. ^changesetid : integer.
  5120. ^attribute : string.
  5121. Example:
  5122. cm ^find ^changeset "^where ^attribute = 'status'"
  5123. (Finds the changesets with the attribute 'status'.)
  5124. ^attrvalue : string.
  5125. ^date : date.
  5126. Check "date constants" for more info in this guide.
  5127. ^owner : user.
  5128. Admits special user '^me'.
  5129. Example:
  5130. cm ^find ^changeset "^where ^date >= '6/8/2018' ^and ^owner != '^me'"
  5131. (Finds all changesets with creation date equal or
  5132. greater than 6/8/2018 and created by others than me.)
  5133. ^GUID : Global Unique Identifier.
  5134. Hexadecimal id in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
  5135. Example:
  5136. cm ^find ^changeset "^where ^guid = '1b30674f-14cc-4fd7-962b-676c8a6f5cb6'"
  5137. (Finds the changeset with the specified guid.)
  5138. ^comment : string.
  5139. Example:
  5140. cm ^find ^changeset "^where ^comment = ''"
  5141. (Finds the changesets with no comments.)
  5142. ^onlywithrevisions : boolean.
  5143. To filter whether a cset has revisions or not.
  5144. Example:
  5145. cm ^find ^changeset "^where ^onlywithrevisions = 'false'"
  5146. (Finds changesets with no revisions.)
  5147. ^returnparent : boolean.
  5148. A way to return the parent of a cset. Good for scripting.
  5149. Example:
  5150. cm ^find ^changeset "^where ^changesetid = 29 ^and ^returnparent = 'true'"
  5151. (Finds the parent of changeset 29.)
  5152. ^parent : changeset id (integer).
  5153. Example:
  5154. cm ^find ^changeset "^where ^parent = 548"
  5155. (Finds all changesets which parent is cset 548.)
  5156. ^ID : integer.
  5157. You can use the '^order ^by' clause with this object. Specifically, you can sort
  5158. by using the following fields:
  5159. ^date
  5160. ^changesetid
  5161. Replication fields. Check "replication related fields" below.
  5162. ^ReplLogId
  5163. ^ReplSrcDate
  5164. ^ReplSrcId
  5165. ^ReplSrcRepository
  5166. ^ReplSrcServer
  5167. ^label:
  5168. You can find labels by filtering using the following fields:
  5169. ^name : string.
  5170. Example:
  5171. cm ^find ^label "^where ^name ^like '7.0.16.%'"
  5172. (Finds the labels with a name that starts with '7.0.16.'.)
  5173. ^attribute : string.
  5174. ^attrvalue : string.
  5175. ^date : date.
  5176. Check "date constants" for more info in this guide.
  5177. Example:
  5178. cm ^find ^label "^where ^date >= '^this ^month' ^and \
  5179. ^attribute = 'publish-status' ^and ^attrvalue != 'PUBLISHED'"
  5180. (Finds the labels created this month with an attribute 'publish-status'
  5181. set to a value other than 'PUBLISHED'.)
  5182. ^owner : user.
  5183. Admits special user '^me'.
  5184. ^GUID : Global Unique Identifier.
  5185. Hexadecimal id in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
  5186. ^branch : branch spec.
  5187. Use 'cm ^help ^objectspec' to learn how to specify this object.
  5188. Example:
  5189. cm ^find ^label "^where ^branch = '/main'"
  5190. (Finds all labels applied to the main branch.)
  5191. ^branchid : integer.
  5192. ^changeset : changeset id (integer).
  5193. Example:
  5194. cm ^find ^label "^where ^changeset = 111733"
  5195. (Finds the labels applied to changeset 111733.)
  5196. ^comment : string.
  5197. ^ID : integer.
  5198. You can use the '^order ^by' clause with this object. Specifically, you can sort
  5199. by using the following fields:
  5200. ^date
  5201. ^labelname
  5202. Replication fields. Check "replication related fields" below.
  5203. ^ReplLogId
  5204. ^ReplSrcDate
  5205. ^ReplSrcId
  5206. ^ReplSrcRepository
  5207. ^ReplSrcServer
  5208. ^merge:
  5209. You can find merges by filtering using the following fields:
  5210. ^srcbranch : branch spec.
  5211. Use 'cm ^help ^objectspec' to learn how to specify this object.
  5212. Example:
  5213. cm ^find ^merge "^where ^srcbranch = '^br:/main'"
  5214. (Finds merges from the main branch.)
  5215. ^srcchangeset : changeset id (integer).
  5216. ^dstbranch : branch spec.
  5217. Use 'cm ^help ^objectspec' to learn how to specify this object.
  5218. ^dstchangeset : changeset id (integer).
  5219. Example:
  5220. cm ^find ^merge "^where ^dstchangeset = 108261" \
  5221. --^format="{^srcbranch} {^srcchangeset} {^dstbranch} {^dstchangeset} {^owner}"
  5222. (Finds the merges to changeset 108261 and prints the
  5223. formatted output showing the source (branch and cset id),
  5224. the destination (branch and cset id), and the merge owner.)
  5225. ^date : date.
  5226. Check "date constants" for more info in this guide.
  5227. ^owner : user.
  5228. Admits special user '^me'.
  5229. ^GUID : Global Unique Identifier.
  5230. Hexadecimal id in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
  5231. ^type : string.
  5232. Possible values are '^merge', '^cherrypick',
  5233. '^cherrypicksubstractive', '^interval', '^intervalcherrypick'
  5234. and '^intervalcherrypicksubstractive'
  5235. Example:
  5236. cm ^find ^merge "^where ^type = '^cherrypick' ^and ^owner = '^me'"
  5237. (Finds all my cherry picks.)
  5238. ^ID : integer.
  5239. ^replicationlog:
  5240. You can find replication log by filtering using the following fields:
  5241. ^branch : branch spec.
  5242. Use 'cm ^help ^objectspec' to learn how to specify this object.
  5243. Example:
  5244. cm ^find ^replicationlog "^where ^branch = '/main/gm22358'"
  5245. (Finds the replication logs of branch 'gm22358'.)
  5246. ^repositoryname : string.
  5247. ^owner : user.
  5248. Admits special user '^me'.
  5249. ^date : date.
  5250. Check "date constants" for more info in this guide.
  5251. ^server : string.
  5252. ^package : boolean.
  5253. Example:
  5254. cm ^find ^replicationlog "^where ^package = 'T' ^and ^server ^like '%cloud%'"
  5255. (Finds the replication logs created from package which
  5256. server name contains 'cloud'.)
  5257. ^ID : integer.
  5258. ^review:
  5259. You can find code reviews by filtering using the following fields:
  5260. ^status : string.
  5261. ^assignee : string.
  5262. Example:
  5263. cm ^find ^review "^where ^status = 'pending' ^and ^assignee = '^me'"
  5264. (Finds all my pending reviews.)
  5265. ^title : string.
  5266. ^target : object spec: branch or changeset.
  5267. Use 'cm ^help ^objectspec' to learn how to specify this object.
  5268. Example:
  5269. cm ^find ^review "^where ^target = '^br:/main/scm17932'"
  5270. (Finds the reviews related to branch 'scm17932'.)
  5271. ^targetid : integer.
  5272. ^targettype : string.
  5273. Possible values are '^branch' and '^changeset'.
  5274. Example:
  5275. cm ^find ^review "^where ^targettype = '^changeset'"
  5276. (Finds the reviews which target type is changeset.)
  5277. ^date : date.
  5278. Check "date constants" for more info in this guide.
  5279. ^owner : user.
  5280. Admits special user '^me'.
  5281. ^GUID : Global Unique Identifier.
  5282. Hexadecimal id in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
  5283. ^ID : integer.
  5284. You can use the '^order ^by' clause with this object. Specifically, you can sort
  5285. by using the following fields:
  5286. ^date
  5287. ^modifieddate
  5288. ^status
  5289. ^revision:
  5290. You can find revisions by filtering using the following fields:
  5291. ^branch : branch spec.
  5292. Use 'cm ^help ^objectspec' to learn how to specify this object.
  5293. ^changeset : changeset id (integer).
  5294. Example:
  5295. cm ^find ^revision "^where ^changeset >= 111756"
  5296. (Finds the revisions created in changeset 111756
  5297. and later.)
  5298. ^item : string or integer.
  5299. ^itemid : integer.
  5300. Examples:
  5301. cm ^find ^revision "^where ^item = 'readme.txt' ^or ^itemid = 2250"
  5302. (Finds the revisions of item 'readme.txt' plus
  5303. item id 2250.)
  5304. cm ^find ^revision "^where ^item = 'readme.txt' ^or ^item = 2250"
  5305. (Gets the same revisions as the previous example.)
  5306. ^attribute : string.
  5307. ^attrvalue : string.
  5308. Example:
  5309. cm ^find ^revision "^where ^attribute = 'status' ^and ^attrvalue != 'open'"
  5310. (Finds the revisions with attribute 'status' which
  5311. value is other than 'open'.)
  5312. ^archived : boolean.
  5313. Example:
  5314. cm ^find ^revision "^where ^archived = 'true'"
  5315. (Finds the revisions that are archived in an
  5316. external storage.)
  5317. ^comment : string.
  5318. ^date : date.
  5319. Check "date constants" for more info in this guide.
  5320. ^GUID : Global Unique Identifier.
  5321. Hexadecimal id in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
  5322. ^owner : user.
  5323. Admits special user '^me'.
  5324. ^parent : revision id (integer).
  5325. ^returnparent : boolean.
  5326. ^shelve : shelve id (integer).
  5327. ^size : integer (in bytes).
  5328. ^type : string.
  5329. Possible values are '^dir', '^bin', and '^txt'.
  5330. Example:
  5331. cm ^find ^revision "^where ^type = '^txt' and \
  5332. ^size > 300000 ^and ^owner = '^me' and ^date >= '2 ^months ^ago'"
  5333. (Finds the text revisions created by me two months
  5334. ago and with size greater than about 3MB.)
  5335. ^workspacecheckoutid : integer.
  5336. ^ID : integer.
  5337. Replication fields. Check "replication related fields" below.
  5338. ^ReplLogId
  5339. ^ReplSrcDate
  5340. ^ReplSrcId
  5341. ^ReplSrcRepository
  5342. ^ReplSrcServer
  5343. ^shelve:
  5344. You can find shelves by filtering using the following fields:
  5345. ^owner : user.
  5346. Admits special user '^me'.
  5347. ^date : date.
  5348. Check "date constants" for more info in this guide.
  5349. Example:
  5350. cm ^find ^shelve "^where ^owner != '^me' ^and ^date >= '^1 ^years ^ago'"
  5351. (Finds the shelves created by others than me during the last
  5352. year.)
  5353. ^attribute : string.
  5354. ^attrvalue : string.
  5355. ^comment : string.
  5356. ^GUID : Global Unique Identifier.
  5357. Hexadecimal id in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
  5358. ^parent : integer.
  5359. ^shelveid : integer.
  5360. Example:
  5361. cm ^find ^shelve "^where ^shelveid = 2"
  5362. (Finds the shelve with name 2.)
  5363. ^ID : integer.
  5364. Example:
  5365. cm ^find ^shelve "^where ^id >= 3848"
  5366. (Finds the shelves which object id is greater than 3848.)
  5367. Replication fields. Check "replication related fields" below.
  5368. ^ReplLogId
  5369. ^ReplSrcDate
  5370. ^ReplSrcId
  5371. ^ReplSrcRepository
  5372. ^ReplSrcServer
  5373. Replication related fields:
  5374. Many objects track replication data, meaning Plastic tracks where they were
  5375. originally created.
  5376. The fields you can use are:
  5377. ^ReplSrcServer : repspec. Stands for "replication source server".
  5378. Server where the object was replicated from.
  5379. Example:
  5380. cm ^find ^branch "^where ^replsrcserver='skull.codicefactory.com:9095'"
  5381. (Finds the branches replicated from server 'skull'.)
  5382. ^ReplSrcRepository : string. Stands for "replication source repo". It is
  5383. the repository where the object was replicated from.
  5384. Example:
  5385. cm ^find ^branch "^where ^replsrcserver = 'skull.codicefactory.com:9095' \
  5386. ^and ^replsrcrepository = 'codice'"
  5387. (Finds the branches replicated from server 'skull'
  5388. and from repository 'codice'.)
  5389. ^ReplLogId : integer. ID of the replication operation. In Plastic,
  5390. each time new objects are created from a replica,
  5391. a new 'replicationlog' is created.
  5392. Example:
  5393. cm ^find ^revision "^where ^repllogid = 2019974"
  5394. (Finds the revisions replicated from replica
  5395. 2019974.)
  5396. ^ReplSrcDate : date. It is the date when the replica actually took
  5397. place.
  5398. Replicated objects will retain its original creation
  5399. date, o this field is useful if you want to find
  5400. objects that where replicated within a specific
  5401. timeframe.
  5402. Example:
  5403. cm ^find ^label "^where ^replsrcdate >= '^one ^month ^ago' \
  5404. ^and ^date >= '15 ^days ^ago'"
  5405. (Finds the labels created 15 days ago and were
  5406. replicated one month ago.)
  5407. cm ^find ^replicationlog "^where ^date > '^one ^week ^ago'"
  5408. 8780433 27/09/2018 8:49:38 codice@BACKYARD:8087 F mbarriosc
  5409. (Finds the replication logs created one week ago.)
  5410. Now, you can check that the replicated branch was
  5411. created before it was replicated over:
  5412. cm ^find ^branch "^where ^repllogid = 8780433"
  5413. 8780443 26/09/2018 12:20:55 /main/scm23078 maria codice T
  5414. ^ReplSrcId : integer. It is the ID of the replication source server.
  5415. You can discover this ID searching for
  5416. '^replicationsource' objects with the 'cm ^find' command.
  5417. Example:
  5418. cm ^find ^replicationsource
  5419. 7860739 codice@AFRODITA:8087 d9c4372a-dc55-4fdc-ad3d-baeb2e975f27
  5420. 8175854 codice@BACKYARD:8087 66700d3a-036b-4b9a-a26f-adfc336b14f9
  5421. Now, you can find the changesets replicated from
  5422. codice@AFRODITA:8087:
  5423. cm ^find ^changesets "^where ^replsrcid = 7860739"
  5424. Date constants:
  5425. You can use date formats that follow your machine localization settings.
  5426. For example, if your computer displays dates in the format 'MM-dd-yyyy',
  5427. you can use dates such as '12-31-2019' in your queries.
  5428. You can also use the following constants to simplify your queries:
  5429. '^today' : today's date.
  5430. '^yesterday' : yesterday's date.
  5431. '^this ^week' : current week's Monday date.
  5432. '^this ^month' : current month's 1st day date.
  5433. '^this ^year' : current year's January 1st date.
  5434. '^one ^day ^ago' : one day before the current date.
  5435. '^one ^week ^ago' : seven days before the current date.
  5436. '^one ^month ^ago' : one month before the current date.
  5437. 'n ^days ^ago' : 'n' days before the current date.
  5438. 'n ^months ^ago' : 'n' months before the current date.
  5439. 'n ^years ^ago' : 'n' years before the current date.
  5440. The following '^where' clauses are valid for fields of type '^date':
  5441. '(...) ^where ^date > '^today' (...)'
  5442. '(...) ^where ^date < '^yesterday' (...)'
  5443. '(...) ^where ^date > '^this ^week' (...)'
  5444. '(...) ^where ^date > '^this ^month' (...)'
  5445. '(...) ^where ^date < '^one ^day ^ago' ^and ^date > '3 ^days ^ago' (...)'
  5446. '(...) ^where ^date < '^one ^week ^ago' ^and ^date > '3 ^weeks ^ago' (...)'
  5447. '(...) ^where ^date < '^one ^month ^ago' ^and ^date > '3 ^months ^ago' (...)'
  5448. '(...) ^where ^date > '1 ^year ^ago' (...)'
  5449. You can also force a specific date format on the 'cm ^find' command using the
  5450. --^dateformat flag. Check 'cm ^find --^help' for further details.
  5451. == CMD_DESCRIPTION_TRIGGER_SHOWTYPES ==
  5452. Displays available trigger types.
  5453. == CMD_USAGE_TRIGGER_SHOWTYPES ==
  5454. Usage:
  5455. cm ^trigger ^showtypes
  5456. == CMD_DESCRIPTION_SHOWACL ==
  5457. Shows the ACL of an object.
  5458. == CMD_USAGE_SHOWACL ==
  5459. Usage:
  5460. cm ^showacl | ^sa <object_spec> [--^extended] [--^xml[=<output_file>]]
  5461. [--^encoding=<name>]
  5462. object_spec Specification of the object to show the ACL of.
  5463. The valid objects for this command are:
  5464. repserver, repository, branch, changeset, label, item,
  5465. and attribute.
  5466. (Use 'cm ^help ^objectspec' to learn more about specs.)
  5467. Options:
  5468. --^extended Shows ACL hierarchy tree.
  5469. --^xml Prints the output in XML format to the standard output.
  5470. It is possible to specify an output file.
  5471. --^encoding Used with the '--^xml' option, specifies the encoding to
  5472. use in the XML output, i.e.: utf-8.
  5473. See the MSDN documentation at
  5474. http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx
  5475. to get the table of supported encodings and its format,
  5476. (at the end of the page, in the "Name" column).
  5477. == CMD_HELP_SHOWACL ==
  5478. Examples:
  5479. cm ^showacl ^repserver:PlasticServer:8084
  5480. (Shows the ACL of the selected server.)
  5481. cm ^sa ^br:/main --^extended
  5482. (Shows the ACL hierarchy tree of the selected branch specification.)
  5483. == CMD_DESCRIPTION_SHOWCOMMANDS ==
  5484. Shows all the available commands.
  5485. == CMD_USAGE_SHOWCOMMANDS ==
  5486. Usage:
  5487. cm ^showcommands
  5488. == CMD_HELP_SHOWCOMMANDS ==
  5489. == CMD_DESCRIPTION_SHOWOWNER ==
  5490. Shows the owner of an object.
  5491. == CMD_USAGE_SHOWOWNER ==
  5492. Usage:
  5493. cm ^showowner | ^so <object_spec>
  5494. object_spec Specification of the object to show the owner of.
  5495. The object must be one of the following:
  5496. repository server, repository, branch, changeset,
  5497. label, attribute, revision, and item.
  5498. (Use 'cm ^help ^objectspec' to learn more about specs.)
  5499. == CMD_HELP_SHOWOWNER ==
  5500. Remarks:
  5501. This command displays the owner of an object. The owner can be a user or
  5502. a group. The owner can be modified with 'cm ^setowner' command.
  5503. Examples:
  5504. cm ^showowner ^repserver:PlasticServer:8084
  5505. (Shows the owner of the selected server.)
  5506. cm ^so ^item:samples\
  5507. (Shows the owner of the selected item specification.)
  5508. == CMD_DESCRIPTION_SHOWPERMISSIONS ==
  5509. Lists the available permissions.
  5510. == CMD_USAGE_SHOWPERMISSIONS ==
  5511. Usage:
  5512. cm ^showpermissions | ^sp
  5513. == CMD_HELP_SHOWPERMISSIONS ==
  5514. Examples:
  5515. cm ^showpermissions
  5516. == CMD_DESCRIPTION_SHOWSELECTOR ==
  5517. Shows the workspace selector.
  5518. == CMD_USAGE_SHOWSELECTOR ==
  5519. This command is deprecated. It is still present for backwards compatibility
  5520. but selectors were largely deprecated in Plastic SCM 4.0. Selectors still
  5521. exist to specify the working branch or changeset, but the old rules to
  5522. filter paths are no longer supported.
  5523. Usage:
  5524. cm ^showselector | ^ss [<wk_path> | <wk_spec>]
  5525. wk_path Path of the workspace to show the selector.
  5526. wk_spec Workspace specification. (Use 'cm ^help ^objectspec' to
  5527. learn more about workspace specs.)
  5528. == CMD_HELP_SHOWSELECTOR ==
  5529. Remarks:
  5530. If neither path nor workspace spec is specified, the command will take the
  5531. current directory as the workspace path.
  5532. Examples:
  5533. cm ^showselector c:\workspace
  5534. (Shows the selector for the selected workspace path.)
  5535. cm ^ss
  5536. (Shows the selector for current workspace.)
  5537. cm ^showselector > mySelector.txt
  5538. (Writes into a file the selector for the current workspace.)
  5539. cm ^showselector ^wk:mywk@reptest
  5540. (Shows the selector for the workspace 'mywk' in the repository 'reptest'.)
  5541. == CMD_DESCRIPTION_SUPPORT ==
  5542. Allows the user to perform support related operations.
  5543. == CMD_USAGE_SUPPORT ==
  5544. Usage:
  5545. cm ^support <command> [options]
  5546. Commands:
  5547. ^bundle
  5548. To get more information about each command run:
  5549. cm ^support <command> --^usage
  5550. cm ^support <command> --^help
  5551. == CMD_HELP_SUPPORT ==
  5552. Examples:
  5553. cm ^support
  5554. cm ^support ^bundle
  5555. cm ^support ^bundle c:\outputfile.zip
  5556. == CMD_DESCRIPTION_SUPPORT_BUNDLE ==
  5557. Creates a "support bundle" package with relevant logs.
  5558. You can attach the file while requesting help, asking for extra info, or
  5559. submitting a bug.
  5560. == CMD_USAGE_SUPPORT_BUNDLE ==
  5561. Usage:
  5562. cm ^support ^bundle [<outputfile>]
  5563. Options:
  5564. outputfile Creates the "support bundle" package at the specified
  5565. location.
  5566. == CMD_HELP_SUPPORT_BUNDLE ==
  5567. Remarks:
  5568. This command allows users to create a "support bundle" package which can be
  5569. attached when requesting help, asking for extra info, or submitting a bug.
  5570. The user can optionally specify a location for the output file; otherwise, the
  5571. output file will be written to the temp directory.
  5572. Examples:
  5573. cm ^support ^bundle
  5574. (Creates "support bundle" in temp directory.)
  5575. cm ^support ^bundle c:\outputfile.zip
  5576. (Creates "support bundle" at the specified location.)
  5577. == CMD_DESCRIPTION_SWITCH ==
  5578. Switches the workspace to a branch, changeset, label, or shelveset.
  5579. == CMD_USAGE_SWITCH ==
  5580. Usage:
  5581. cm ^switch (<brspec> | <csetspec> | <lbspec> | <shspec>)
  5582. [--^workspace=<path>] [--^repository=<name>]
  5583. [--^forcedetailedprogress]
  5584. (Use 'cm ^help ^objectspec' to learn more about branch, changeset, label,
  5585. and shelveset specifications.)
  5586. Options:
  5587. --^workspace Path where the workspace is located.
  5588. --^repository Switches to the specified repository.
  5589. --^forcedetailedprogress Forces detailed progress even when standard
  5590. output is redirected.
  5591. == CMD_HELP_SWITCH ==
  5592. Remarks:
  5593. This command allows users to update the workspace tree to the contents
  5594. of the specified object (branch, label, shelveset, or changeset).
  5595. Examples:
  5596. cm ^switch ^br:/main
  5597. cm ^switch ^lb:Rel1.1
  5598. cm ^switch ^br:/main/scm002 --^repository=rep2
  5599. cm ^switch ^cs:4375
  5600. cm ^switch ^sh:2
  5601. == CMD_DESCRIPTION_SWITCH_TO_BRANCH ==
  5602. Sets a branch as the working branch.
  5603. == CMD_USAGE_SWITCH_TO_BRANCH ==
  5604. This command is deprecated. Use cm switch instead.
  5605. Usage:
  5606. cm ^switchtobranch [options] [branch_spec]
  5607. branch_spec: Branch specification.
  5608. Options:
  5609. --^label=name | --^changeset=number: load revisions from the specified
  5610. label or changeset. One of these options is required if no branch_spec is
  5611. given.
  5612. --^changeset=cset: Switch to the specified changeset.
  5613. --^repository=rep: Switch to the specified repository.
  5614. --^workspace | -wk=path: path where the workspace is located.
  5615. == CMD_HELP_SWITCH_TO_BRANCH ==
  5616. Remarks:
  5617. This command allows users to work in a branch.
  5618. If no branch_spec specified, a label or a changeset must be specified.
  5619. If no repository is specified, the branch is set to the current repository.
  5620. Examples:
  5621. cm ^switchtobranch ^br:/main
  5622. cm ^switchtobranch ^br:/main/task001
  5623. cm ^switchtobranch --^label=BL050
  5624. (Read-only configuration. The command loads the contents of the labeled
  5625. changeset.)
  5626. == CMD_DESCRIPTION_SYNC ==
  5627. Synchronize with Git.
  5628. == CMD_USAGE_SYNC ==
  5629. Usage:
  5630. cm ^synchronize | ^sync <repspec> ^git [<url> [--^user=<usr_name> --^pwd=<pwd>]]
  5631. [(--^txtsimilaritypercent | --^binsimilaritypercent | \
  5632. --^dirsimilaritypercent)=<value>]
  5633. [--^author] [--^skipgitlfs] [--^gitpushchunk=<value>]
  5634. repspec Repository specification. (Use 'cm ^help ^objectspec' t
  5635. learn more about repository specs.)
  5636. git (Default).
  5637. Options:
  5638. url Remote repository URL (http(s):// or git:// or a
  5639. SSH URL).
  5640. --^user User name for the specified URL.
  5641. --^pwd Password for the specified URL.
  5642. --^txtsimilaritypercent \
  5643. --^binsimilaritypercent \
  5644. --^dirsimilaritypercent
  5645. To detect moved items, the same way as Plastic SCM
  5646. GUI does.
  5647. --^author Uses name and timestamp values from the git author.
  5648. (git committer by default)
  5649. --^skipgitlfs Ignores the Git LFS configuration in the
  5650. .gitattributes file. It acts like without Git LFS
  5651. support.
  5652. --^gitpushchunk Process the push operation (exporting changes from
  5653. Plastic to Git) in chunks of a certain number of
  5654. changesets. This is only useful for huge repos to
  5655. avoid network or package size related issues or
  5656. just for debugging purposes. It uses chunks of
  5657. 1000 changesets if no value is specified.
  5658. == CMD_HELP_SYNC ==
  5659. Remarks:
  5660. If the git repository requires user and password, then use '^url', '--^user',
  5661. and '--^pwd' options.
  5662. If the git repository doesn't require user and password, then use '^url'
  5663. option with the first sync operation. With next sync operations, '^url'
  5664. option is optional.
  5665. To use the SSH protocol to perform the sync, you must have the 'ssh' client
  5666. added to the PATH environment variable and properly configured to connect
  5667. to the remote host (i.e. private/public keys configured).
  5668. Examples:
  5669. cm ^sync default@localhost:8087 ^git git://localhost/repository
  5670. == CMD_DESCRIPTION_TRIGGER ==
  5671. Allows the user to manage triggers.
  5672. == CMD_USAGE_TRIGGER ==
  5673. Usage:
  5674. cm ^trigger | ^tr <command> [options]
  5675. Commands:
  5676. ^create | ^mk
  5677. ^delete | ^rm
  5678. ^edit
  5679. ^list | ^ls
  5680. ^showtypes
  5681. To get more information about each command run:
  5682. cm ^trigger <command> --^usage
  5683. cm ^trigger <command> --^help
  5684. == CMD_HELP_TRIGGER ==
  5685. Examples:
  5686. cm ^tr ^mk ^before-mklabel new "/path/to/script" --^server=myserver:8084
  5687. cm ^tr ^edit ^before-mklabel 7 --^position=4 --^server=myserver:8084
  5688. cm ^tr ^ls ^before-mkbranch --^server=myserver:8084
  5689. cm ^tr ^rm ^after-setselector 4
  5690. cm ^tr ^showtypes
  5691. == CMD_DESCRIPTION_TUBE ==
  5692. Runs commands related to Plastic Tube.
  5693. == CMD_USAGE_TUBE ==
  5694. Usage:
  5695. cm ^tube ^config -^u=<user> -^p=<password>
  5696. (Configures Plastic SCM to use Plastic Tube with the specified user and
  5697. password.)
  5698. cm ^tube ^create <remoteuser>
  5699. (Creates the tube "remoteuser -> myuser".
  5700. The user "myuser" allows to "remoteuser" to connect to "myuser" server.
  5701. Connections can be established from "remoteuser" to "myuser".
  5702. Only tubes from other users to the current tube user can be created.)
  5703. cm ^tube ^remove <remoteuser>
  5704. (Removes the tube "remoteuser -> myuser".)
  5705. cm ^tube ^local
  5706. (Lists the local repositories shared in the local server and the users
  5707. that it is shared with.)
  5708. cm ^tube ^remote
  5709. (Lists the shared remote repositories that are shared with the current
  5710. tube user.)
  5711. cm ^tube ^share <rep_spec>[ ...] -^u=<remoteuser> -^a=(^pull | ^push | ^pull,^push)
  5712. (Shares the local repository(s) with the remote user and sets the specified
  5713. access mode. Use a whitespace to separate repository specs.)
  5714. cm ^tube ^unshare <rep_spec>[ ...] -^u=<remoteuser>
  5715. (Unshares the local repository(s) with the remote user. Use a whitespace to
  5716. separate repository specs.)
  5717. cm ^tube ^connect
  5718. (Connects the Plastic SCM server to Plastic Tube.)
  5719. cm ^tube ^disconnect
  5720. (Disconnects the Plastic SCM server from Plastic Tube.)
  5721. cm ^tube ^status
  5722. (Shows if the Plastic SCM server is connected to Plastic Tube.)
  5723. Options
  5724. -^u Tube user (the plasticscm.com user).
  5725. -^p User password.
  5726. -^a Sets the access mode.
  5727. rep_spec Repository specification. (Use 'cm ^help ^objectspec' to
  5728. learn more about repository specs.)
  5729. == CMD_HELP_TUBE ==
  5730. Remarks:
  5731. Use the 'cm ^tube' command to manage Plastic Tube.
  5732. Examples:
  5733. cm ^tube ^config -^u=ruben@codicesoftware.com -^p=rubenpassword
  5734. cm ^tube ^create pablo@codicesoftware.com
  5735. ('pablo@codicesoftware.com' can connect to the current Plastic Tube user)
  5736. cm ^tube ^remove pablo@codicesoftware.com
  5737. cm ^tube ^local
  5738. cm ^tube ^remote
  5739. cm ^tube ^share repo@server:8087 -^u=pablo@codicesoftware.com -^a=^pull,^push
  5740. cm ^tube ^share repo@server:8087 doc@server:8087 -^u=pablo@codicesoftware.com -^a=^push
  5741. cm ^tube ^unshare repo@server:8087 -^u=pablo@codicesoftware.com
  5742. cm ^tube ^connect
  5743. cm ^tube ^disconnect
  5744. cm ^tube ^status
  5745. == CMD_DESCRIPTION_UNCO ==
  5746. Undoes the checkout of an item.
  5747. == CMD_USAGE_UNCO ==
  5748. Usage:
  5749. cm ^undocheckout | ^unco <item_path>[ ...] [-^a | --^all] [--^symlink] [--^silent]
  5750. [--^machinereadable [--^startlineseparator=<sep>]
  5751. [--^endlineseparator=<sep>] [--^fieldseparator=<sep>]]
  5752. item_path Items to apply the operation. Use a whitespace to separate
  5753. paths. Use double quotes (" ") to specify paths
  5754. containing spaces.
  5755. Use . to apply the operation to current directory.
  5756. Options:
  5757. -^a | --^all Undoes all of the changes in the specified items. If
  5758. the item(s) were checked out, the checkout will be
  5759. reverted. If the item(s) were locally modified, the
  5760. modifications will be reverted.
  5761. --^symlink Applies the undocheckout operation to the link and not
  5762. to the target.
  5763. --^silent Does not show any output.
  5764. --^machinereadable Outputs the result in an easy-to-parse format.
  5765. --^startlineseparator Used with the '--^machinereadable' flag,
  5766. specifies how the lines should start.
  5767. --^endlineseparator Used with the '--^machinereadable' flag,
  5768. specifies how the lines should end.
  5769. --^fieldseparator Used with the '--^machinereadable' flag,
  5770. specifies how the fields should be separated.
  5771. == CMD_HELP_UNCO ==
  5772. Remarks:
  5773. If an item is checked out and you do not want to checkin it, you can undo
  5774. the checkout using this command. Both files and folders can be unchecked
  5775. out. The item will be updated to the state it had before checking it out.
  5776. Requirements:
  5777. - The item must be under source code control.
  5778. - The item must be checked out.
  5779. Reading input from stdin:
  5780. The '^undocheckout' command can read paths from stdin. To do this, pass a
  5781. single dash "-".
  5782. Example: cm ^undocheckout ^checkin -
  5783. Paths will be read until an empty line is entered.
  5784. This allows you to use pipe to specify for which files to undo the checkout.
  5785. Example:
  5786. dir /S /B *.c | cm ^undocheckout --^all -
  5787. (In Windows, undoes the checkout of all .c files in the workspace.)
  5788. Examples:
  5789. cm ^undocheckout .
  5790. (Undoes checkouts in the current directory.)
  5791. cm ^undocheckout file1.txt file2.txt
  5792. cm unco c:\workspace\file.txt
  5793. (Undoes checkouts of the selected files.)
  5794. cm ^unco -^a file1.txt
  5795. (Undoes checkouts or local modifications of 'file1.txt')
  5796. cm ^unco link --^symlink
  5797. (Applies the undocheckout operation to the symlink file and not to the target.)
  5798. cm ^status --^short --^changelist=pending_to_review | cm ^undocheckout -
  5799. (Undoes client changelist.
  5800. The command above will list the paths in the changelist named
  5801. 'pending_to_review' and the path list will be redirected to the input of the
  5802. undocheckout command).
  5803. cm ^unco . --^machinereadable
  5804. (Undoes checkouts in the current directory, and prints the result in a
  5805. simplified, easier-to-parse format.)
  5806. cm ^unco . --^machinereadable --^startlineseparator=">" --^endlineseparator="<" \
  5807. --^fieldseparator=","
  5808. (Undoes checkouts in the current directory, and prints the result in a
  5809. simplified, easier to parse format, starting and ending the lines, and
  5810. separating the fields, with the specified strings.)
  5811. == CMD_DESCRIPTION_UNCOUNCHANGED ==
  5812. Undoes non-changed checked out items.
  5813. == CMD_USAGE_UNCOUNCHANGED ==
  5814. Usage:
  5815. cm ^uncounchanged | ^unuc <item_path>[ ...] [-^R | -^r | --^recursive]
  5816. [--^symlink] [--^silent]
  5817. item_path Items to apply the operation. Use a whitespace to separate
  5818. paths. Use double quotes (" ") to specify paths
  5819. containing spaces.
  5820. Use . to apply the operation to current directory.
  5821. Options:
  5822. -^R Undoes unchanged items recursively in the specified paths.
  5823. --^symlink Applies the uncounchanged operation to the link and not
  5824. to the target.
  5825. --^silent Does not show any output.
  5826. == CMD_HELP_UNCOUNCHANGED ==
  5827. Remarks:
  5828. This command is applied from the root of the workspace recursively.
  5829. Reading input from stdin:
  5830. The '^uncounchanged' command can read paths from stdin. To do this, pass a
  5831. single dash "-".
  5832. Example: cm ^uncounchanged -
  5833. Paths will be read until an empty line is entered.
  5834. This allows you to use pipe to specify for which unchanged files to undo
  5835. the checkout.
  5836. Example:
  5837. dir /S /B *.c | cm ^uncounchanged -
  5838. (In Windows, undoes the checkout on all unchanged .c files in the
  5839. workspace.)
  5840. Examples:
  5841. cm ^uncounchanged . -^R
  5842. (Undoes checkouts of not changed files recursively on the current directory.)
  5843. cm ^unuc /home/myuser/mywk/project/templates -^R
  5844. (Undoes checkouts of not changed files recursively on the selected directory.)
  5845. == CMD_DESCRIPTION_UNDELETE ==
  5846. Undeletes an item using a specific revision.
  5847. == CMD_USAGE_UNDELETE ==
  5848. Usage:
  5849. cm ^undelete <revspec> <path>
  5850. revspec Specification of the revision whose contents will
  5851. be loaded in the workspace. (Use 'cm ^help ^objectspec' to
  5852. learn more about revision specs.)
  5853. path Restore path.
  5854. == CMD_HELP_UNDELETE ==
  5855. Remarks:
  5856. The item to undelete should not be already loaded in the workspace.
  5857. The '^undelete' operation is not supported for xlinks.
  5858. Example:
  5859. cm ^undelete ^revid:756 C:\mywks\src\foo.c
  5860. cm ^undelete ^itemid:68#^cs:2 C:\mywks\dir\myfile.pdf
  5861. cm ^undelete ^serverpath:/src#^br:/main C:\mywks\Dir
  5862. == CMD_DESCRIPTION_UNDOCHANGE ==
  5863. Undoes the changes on a path.
  5864. == CMD_USAGE_UNDOCHANGE ==
  5865. Usage:
  5866. cm ^undochange | ^unc <item_path>[ ...] [-^R | -^r | --^recursive]
  5867. item_path Items to apply the operation. Use a whitespace to separate
  5868. paths. Use double quotes (" ") to specify paths
  5869. containing spaces.
  5870. Use . to apply the operation to current directory.
  5871. Options:
  5872. -^R Applies the operation recursively.
  5873. == CMD_HELP_UNDOCHANGE ==
  5874. Remarks:
  5875. If an item is checked out or modified but not checked in and you do not
  5876. want to check it in, you can undo the changes using this command. The item
  5877. will be updated to the contents it had before.
  5878. Reading input from stdin:
  5879. The '^undochange' command can read paths from stdin. To do this, pass a
  5880. single dash "-".
  5881. Example: cm ^undochange -
  5882. Paths will be read until an empty line is entered.
  5883. This allows you to use pipe to specify for which files to undo changes.
  5884. Example:
  5885. dir /S /B *.c | cm ^undochange -
  5886. (In Windows, undoes the changes of all .c files in the workspace.)
  5887. Examples:
  5888. cm ^unc .
  5889. (Undoes changes of the files on the current directory.)
  5890. cm ^undochange . -^R
  5891. (Undoes changes of the files recursively on the current directory.)
  5892. cm ^unc file1.txt "file 2.txt"
  5893. (Undoes changes of the selected files.)
  5894. cm ^unc c:\workspace\file.txt
  5895. (Undoes changes of the selected file.)
  5896. == CMD_DESCRIPTION_UNDO ==
  5897. Undoes changes in a workspace.
  5898. == CMD_USAGE_UNDO ==
  5899. Usage:
  5900. cm ^undo [<path>[ ...]] [--^symlink] [-^r | --^recursive] [<filter>[ ...]]
  5901. [--^silent | --^machinereadable [--^startlineseparator=<sep>]
  5902. [--^endlineseparator=<sep>] [--^fieldseparator=<sep>]]
  5903. path Path of the files or directories to apply the operation to.
  5904. Use double quotes (" ") to specify paths containing spaces.
  5905. Use a whitespace to separate paths.
  5906. If no path is specified, by default the undo operation will take
  5907. all of the files in the current directory.
  5908. filter Applies the specified filter or filters to the given paths. Use
  5909. a whitespace to separate filters. See the Filters section for
  5910. more information.
  5911. Options:
  5912. --^symlink Applies the undo operation to the symlink and not
  5913. to the target.
  5914. -^r Executes the undo recursively.
  5915. --^silent Does not show any output.
  5916. --^machinereadable Outputs the result in an easy-to-parse format.
  5917. --^startlineseparator Used with the '--^machinereadable' flag, specifies
  5918. how the lines should start.
  5919. --^endlineseparator Used with the '--^machinereadable' flag, specifies
  5920. how the lines should end.
  5921. --^fieldseparator Used with the '--^machinereadable' flag, specifies
  5922. how the fields should be separated.
  5923. Filters:
  5924. The paths can be filtered using one or more of the filters below. Each of
  5925. those filters refers to a type of change:
  5926. --^checkedout Selects checked-out files and directories.
  5927. --^unchanged Selects files whose content is unchanged.
  5928. --^changed Selects locally changed or checked-out files and directories.
  5929. --^deleted Selects deleted files and directories.
  5930. --^moved Selects moved files and directories.
  5931. --^added Selects added files and directories.
  5932. If the path matches one or more of the specified kinds of changes, those
  5933. types of changes will be undone on that said path.
  5934. For example, if you specify both '--^checkedout' and '--^moved', if a file
  5935. is both checkedout and moved, both changes will be undone.
  5936. If no filter is specified, all kinds of changes are undone.
  5937. == CMD_HELP_UNDO ==
  5938. Remarks:
  5939. - If no path is specified, it will undo every change in the current
  5940. directory but not recursively.
  5941. - If one or more paths are specified, it will undo every change in the
  5942. specified paths but not recursively.
  5943. - If you want the operation to be recursive, you must specify the '-^r' flag.
  5944. To undo all of the changes below a directory including changes affecting
  5945. the directory itself, run the following command:
  5946. cm ^undo dirpath -^r
  5947. If dirpath is a workspace path, every change in the workspace will be
  5948. undone.
  5949. - The '^undo' command is dangerous because it undoes work irreversibly.
  5950. Once the ^undo has finished, it is not possible to recover the previous
  5951. state of the files and directories affected by it.
  5952. - Consider the following scenario:
  5953. /src
  5954. |- file.txt
  5955. |- code.cs
  5956. \- /test
  5957. |- test_a.py
  5958. \- test_b.py
  5959. These commands are equivalent when executed from the /src directory:
  5960. cm ^undo
  5961. cm ^undo *
  5962. cm ^undo file.txt code.cs /test
  5963. These commands are also equivalent when executed from the /src directory:
  5964. cm ^undo .
  5965. cm ^undo /src file.txt code.cs
  5966. Deleted items:
  5967. To undo file and directory deletions, you must either specify the full path
  5968. of the item, or specify the containing directory and use the recursive ('-^r')
  5969. flag.
  5970. For example:
  5971. cm ^undo .
  5972. (Does NOT undo deletions (but other changes) in the current directory.)
  5973. cm ^undo . -^r
  5974. (Undoes all deletions (and other changes) in the current directory
  5975. recursively.)
  5976. cm ^undo src/file.txt
  5977. (Undoes deletion (or other change) of src/file.txt.)
  5978. Examples:
  5979. cm ^undo . -^r
  5980. (Undoes all changes in the current directory recursively. If executed
  5981. from the workspace's root, undoes all changes in the entire workspace.)
  5982. cm ^co file.txt
  5983. cm ^undo file.txt
  5984. (Undoes the checkout on 'file.txt'.)
  5985. cm ^undo c:\otherworkspace\file.txt
  5986. (Undoes changes in file 'file.txt' located in a workspace other than the
  5987. current one.)
  5988. ^echo ^content >> file.txt
  5989. cm ^undo file.txt
  5990. (Undoes the local change to 'file.txt'.)
  5991. cm ^undo src
  5992. (Undoes changes to the src directory and its files.)
  5993. cm ^undo src/*
  5994. (Undoes changes in every file and directory contained in src, without
  5995. affecting src.)
  5996. cm ^undo *.cs
  5997. (Undoes changes to every file or directory that matches *.cs in the current
  5998. directory.)
  5999. cm ^undo *.cs -^r
  6000. (Undoes changes on every file or directory that matches *.cs in the current
  6001. directory and every directory below it.)
  6002. cm ^co file1.txt file2.txt
  6003. ^echo ^content >> file1.txt
  6004. cm ^undo --^unchanged
  6005. (Undoes the checkout of unchanged 'file2.txt', ignoring locally changed
  6006. 'file1.txt'.)
  6007. ^echo ^content >> file1.txt
  6008. ^echo ^content >> file2.txt
  6009. cm ^co file1.txt
  6010. cm ^undo --^checkedout
  6011. (Undoes the changes in checked-out file 'file1.txt', ignoring 'file2.txt' as
  6012. it is not checked-out.)
  6013. cm ^add file.txt
  6014. cm ^undo file.txt
  6015. (Undo the add of 'file.txt' making it once again a private file.)
  6016. ^rm file1.txt
  6017. ^echo ^content >> file2.txt
  6018. cm ^add file3.txt
  6019. cm ^undo --^deleted --^added *
  6020. (Undoes the 'file1.txt' delete and 'file3.txt' add, ignoring the 'file2.txt'
  6021. change.)
  6022. == CMD_DESCRIPTION_LOCK_UNLOCK ==
  6023. Undoes item locks on a lockserver.
  6024. == CMD_USAGE_LOCK_UNLOCK ==
  6025. Usage:
  6026. cm ^lock ^unlock [<repserverspec>] <guid>[ ...]
  6027. repserverspec Repository server specification. (Use 'cm ^help ^objectspec'
  6028. to learn more about repserver specs.)
  6029. guid A list of item GUIDs to be unlocked. Use a whitespace to
  6030. separate GUIDs.
  6031. == CMD_HELP_LOCK_UNLOCK ==
  6032. Remarks:
  6033. - The command uses the specified server to unlock the items.
  6034. - If no server is specified, the command tries to obtain a server from the
  6035. current workspace.
  6036. - If no server was calculated on the previous steps, the server is obtained
  6037. from the current Plastic SCM client configuration.
  6038. - Only the administrator of the server can run the 'cm ^unlock' command.
  6039. - To specify a GUID, the format should be the 32-digit separated by
  6040. hyphens format (optionally enclosed in braces):
  6041. {00000000-0000-0000-0000-000000000000}
  6042. or
  6043. 00000000-0000-0000-0000-000000000000
  6044. Examples:
  6045. cm ^lock ^unlock 91961b14-3dfe-4062-8c4c-f33a81d201f5
  6046. (Undoes the selected item lock.)
  6047. cm ^lock ^unlock DIGITALIS:8084 2340b4fa-47aa-4d0e-bb00-0311af847865 \
  6048. bcb98a61-2f62-4309-9a26-e21a2685e075
  6049. (Undoes the selected item locks on lockserver named 'DIGITALIS'.)
  6050. cm ^lock ^unlock tardis@cloud 4740c4fa-56af-3dfe-de10-8711fa248635 \
  6051. 71263c17-5eaf-5271-4d2c-a25f72e101d4
  6052. (Undoes the selected item locks on cloud lockserver named 'tardis'.)
  6053. == CMD_DESCRIPTION_UPDATE ==
  6054. Updates the workspace and downloads latest changes.
  6055. == CMD_USAGE_UPDATE ==
  6056. Usage:
  6057. cm ^update [<item_path> | --^last]
  6058. [--^changeset=<csetspec>] [--^cloaked] [--^dontmerge] [--^forced]
  6059. [--^ignorechanges] [--^override] [--^recursewk] [--^skipchangedcheck]
  6060. [--^silent] [--^verbose] [--^xml[=<output_file>]] [--^encoding=<name>]
  6061. [--^machinereadable [--^startlineseparator=<sep>]
  6062. [--^endlineseparator=<sep>] [--^fieldseparator=<sep>]]
  6063. [--^forcedetailedprogress]
  6064. item_path Path to update.
  6065. Use . to apply update to current directory.
  6066. If no path is specified, then the current workspace is
  6067. fully updated.
  6068. --^last Changes the workspace selector from a changeset
  6069. configuration or a label configuration to a branch
  6070. configuration before updating.
  6071. The selector is changed to the branch the changeset or
  6072. label belongs to.
  6073. Options:
  6074. --^changeset Updates the workspace to a specific changeset.
  6075. (Use 'cm ^help ^objectspec' to learn more about
  6076. changeset specs.)
  6077. --^cloaked Includes the cloaked items in the update operation.
  6078. If this option is not specified, those items that are
  6079. cloaked will be ignored in the operation.
  6080. --^dontmerge In case an update merge is required during the update
  6081. operation, does not perform it.
  6082. --^forced Forces updating items to the revision specified in
  6083. the selector.
  6084. --^ignorechanges Ignores the pending changes warning message that is
  6085. shown if there are pending changes detected when
  6086. updating the workspace.
  6087. --^override Overrides changed files outside Plastic SCM control.
  6088. Their content will be overwritten with the server
  6089. content.
  6090. --^recursewk Updates all the workspaces found within the current
  6091. path. Useful to update all the workspaces contained
  6092. in a specific path.
  6093. --^skipchangedcheck Checks if there are local changes in your workspace
  6094. before starting. If you always checkout before
  6095. modifying a file, you can use this check and speed
  6096. up the operation.
  6097. --^silent Does not show any output.
  6098. --^verbose Shows additional information.
  6099. --^xml Prints the output in XML format to the standard output.
  6100. It is possible to specify an output file.
  6101. --^encoding Used with the --^xml option, specifies the encoding to
  6102. use in the XML output, i.e.: utf-8.
  6103. See the MSDN documentation at
  6104. http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx
  6105. to get the table of supported encodings and its format,
  6106. (at the end of the page, in the "Name" column).
  6107. --^machinereadable Outputs the result in an easy-to-parse format.
  6108. --^startlineseparator Used with the '--^machinereadable' flag,
  6109. specifies how the lines should start.
  6110. --^endlineseparator Used with the '--^machinereadable' flag,
  6111. specifies how the lines should end.
  6112. --^fieldseparator Used with the '--^machinereadable' flag,
  6113. specifies how the fields should be separated.
  6114. --^forcedetailedprogress Forces detailed progress even when standard output
  6115. is redirected.
  6116. == CMD_HELP_UPDATE ==
  6117. Remarks:
  6118. The '^update' command only downloads needed files.
  6119. The command assumes recursive operation.
  6120. When the '--^last' option is used, it is not necessary to specify a path.
  6121. In this case, the workspace the current working directory belongs to will
  6122. be updated.
  6123. (Remember that specifying this flag could cause the workspace
  6124. selector to be changed to a branch configuration if the selector was
  6125. previously pointing to a changeset or a label.)
  6126. Examples:
  6127. cm ^update
  6128. (Updates all in the current workspace.)
  6129. cm ^update .
  6130. (Updates current directory, and all children items.)
  6131. cm ^update . --^forced --^verbose
  6132. (Forces retrieval of all revisions.)
  6133. cm ^update --^last
  6134. cm ^update . --^machinereadable --^startlineseparator=">"
  6135. (Updates current directory and prints the result in a simplified
  6136. easier-to-parse format, starting the lines with the specified
  6137. strings.)
  6138. == CMD_DESCRIPTION_VERSION ==
  6139. Shows the current client version number.
  6140. == CMD_USAGE_VERSION ==
  6141. Usage:
  6142. cm ^version
  6143. == CMD_HELP_VERSION ==
  6144. == CMD_DESCRIPTION_WHOAMI ==
  6145. Shows the current Plastic SCM user.
  6146. == CMD_USAGE_WHOAMI ==
  6147. Usage:
  6148. cm ^whoami
  6149. == CMD_HELP_WHOAMI ==
  6150. == CMD_USAGE_WKTREENODESTATUS ==
  6151. Usage:
  6152. cm ^wktreenodestatus path1, path2, ...
  6153. == CMD_DESCRIPTION_WORKSPACE ==
  6154. Allows the user to manage workspaces.
  6155. == CMD_USAGE_WORKSPACE ==
  6156. Usage:
  6157. cm ^workspace | ^wk <command> [options]
  6158. Commands:
  6159. ^list | ^ls
  6160. ^create | ^mk
  6161. ^delete | ^rm
  6162. ^move | ^mv
  6163. ^rename
  6164. To get more information about each command run:
  6165. cm ^workspace <command> --^usage
  6166. cm ^workspace <command> --^help
  6167. == CMD_HELP_WORKSPACE ==
  6168. Examples:
  6169. cm ^workspace ^create myWorkspace wk_path
  6170. cm ^workspace ^list
  6171. cm ^workspace ^delete myWorkspace
  6172. == CMD_DESCRIPTION_WORKSPACE_CREATE ==
  6173. Creates a new workspace.
  6174. == CMD_USAGE_WORKSPACE_CREATE ==
  6175. Usage:
  6176. cm ^workspace | ^wk [^create | ^mk] <rep_spec>
  6177. [^create | ^mk] <wk_name> <wk_path> [<rep_spec>]
  6178. [^create | ^mk] <wk_name> <wk_path> [--^selector[=<selector_file>]
  6179. (Creates a new workspace.)
  6180. cm ^workspace | ^wk [^create | ^mk] <wk_name> <wk_path> --^dynamic --^tree=[<tree>]
  6181. (Creates a dynamic workspace. This feature is still experimental, and it's
  6182. only available for Windows.)
  6183. wk_name The new workspace name.
  6184. wk_path Path of the new workspace.
  6185. rep_spec Creates the new workspace with the specified repository.
  6186. Repository specification: check 'cm ^help ^objectspec'.
  6187. Options:
  6188. --^selector Edits a selector for the new workspace.
  6189. If a selector file is specified, then sets the selector
  6190. for the new workspace from the specified file.
  6191. --^dynamic Creates a dynamic workspace. This feature is still
  6192. experimental, and it's only available for Windows.
  6193. Specifying this flag requires using the --^tree parameter.
  6194. --^tree Used with the '--^dynamic' flag, specifies the initial
  6195. point the dynamic workspace is going to load. It can
  6196. either be a branch, changeset, or label specification.
  6197. The workspace will later on use the repository in the
  6198. spec. (Use 'cm ^help ^objectspec' to learn more about specs.)
  6199. == CMD_HELP_WORKSPACE_CREATE ==
  6200. Remarks:
  6201. - A workspace is a view of the repository mapped to the local filesystem.
  6202. The workspace selector defines the rules that specify workspace content.
  6203. Use 'cm ^showselector' to display a workspace selector or 'cm ^setselector'
  6204. to modify it.
  6205. - If neither rep_spec nor '--^selector' is specified, then the workspace
  6206. will automatically be configured to use the first repository
  6207. (alphabetically) of the server configured in the client.conf file.
  6208. - The dynamic workspaces is a experimental feature (Windows only), and it
  6209. requires the plasticfs.exe program running.
  6210. Examples:
  6211. cm ^workspace ^create mycode
  6212. cm ^wk ^mk mycode
  6213. (Creates a 'mycode' workspace pointing to the repository with the same name.
  6214. The workspace directory will be created under the current directory.)
  6215. cm ^wk ^mk mycode@localhost:8084
  6216. cm ^wk ^mk mycode@myorganization@cloud
  6217. (Creates a 'mycode' workspace as before, but you can specify different repository server.)
  6218. cm ^workspace ^create myworkspace c:\workspace
  6219. cm ^wk ^mk myworkspace /home/john/plastic_view
  6220. (Creates 'myworkspace' workspace in Windows and in Linux respectively.)
  6221. cm ^wk mywktest c:\wks\wktest --^selector=myselector.txt
  6222. (Creates 'mywktest' workspace using the selector in 'myselector.txt' file.)
  6223. cm ^wk mywkprj c:\wks\wkprj myrep@^repserver:localhost:8084
  6224. (Creates 'mywkprj' workspace with the selected repository.)
  6225. cm ^wk mywkprj c:\dynwks\mywkprj --^dynamic --^tree=^br:/main@myrep@localhost:8084
  6226. (Creates dynamic 'mywkprj' workspace with the 'myrep@localhost:8084'
  6227. repository, pointing to '^br:/main' the first time it gets mounted.)
  6228. == CMD_DESCRIPTION_WORKSPACE_DELETE ==
  6229. Deletes a workspace.
  6230. == CMD_USAGE_WORKSPACE_DELETE ==
  6231. Usage:
  6232. cm ^workspace | ^wk ^delete | ^rm [<wk_path> | <wkspec>] [--^keepmetadata]
  6233. wk_path Path of the workspace to be deleted.
  6234. wkspec Specification of the workspace to delete. (Use
  6235. 'cm ^help ^objectspec' to learn more about specs.)
  6236. Options:
  6237. --^keepmetadata Does not delete the metadata files in the .plastic
  6238. folder.
  6239. == CMD_HELP_WORKSPACE_DELETE ==
  6240. Remarks:
  6241. This command deletes a workspace, specified by path or spec.
  6242. If no arguments are specified, current workspace will be assumed.
  6243. Examples:
  6244. cm ^workspace ^delete
  6245. (Removes current workspace.)
  6246. cm ^wk ^delete c:\workspace
  6247. cm ^workspace rm /home/danipen/wks
  6248. cm ^wk ^rm ^wk:MiWorkspace
  6249. cm ^wk ^rm ^wk:MiWorkspace@DIGITALIS
  6250. == CMD_DESCRIPTION_WORKSPACE_LIST ==
  6251. Lists workspaces.
  6252. == CMD_USAGE_WORKSPACE_LIST ==
  6253. Usage:
  6254. cm ^workspace | ^wk [^list | ^ls] [--^format=<str_format>]
  6255. Options:
  6256. --^format Retrieves the output message in a specific format. See
  6257. Remarks for more info.
  6258. == CMD_HELP_WORKSPACE_LIST ==
  6259. Remarks:
  6260. Output format parameters (--^format option):
  6261. This command accepts a format string to show the output.
  6262. The output parameters of this command are the following:
  6263. {0} | {^wkname} Workspace name.
  6264. {1} | {^machine} Client machine name.
  6265. {2} | {^path} Workspace path.
  6266. {3} | {^wkid} Workspace unique identifier.
  6267. {4} | {^wkspec} Workspace specification using the format:
  6268. 'wkname@machine'.
  6269. {^tab} Inserts a tab space.
  6270. {^newline} Inserts a new line.
  6271. Examples:
  6272. cm ^wk
  6273. (Lists all workspaces.)
  6274. cm ^workspace ^list --^format={0}#{3,40}
  6275. cm ^workspace ^list --^format={^wkname}#{^wkid,40}
  6276. (Lists all workspaces and shows the workspace name, a # symbol and the
  6277. workspace GUID field in 40 spaces, aligned to left.)
  6278. cm ^wk --^format="Workspace {0} in path {2}"
  6279. cm ^wk --^format="Workspace {^wkname} in path {^path}"
  6280. (Lists all workspaces and shows result as formatted strings.)
  6281. == CMD_DESCRIPTION_WORKSPACE_MOVE ==
  6282. Moves a workspace.
  6283. == CMD_USAGE_WORKSPACE_MOVE ==
  6284. Usage:
  6285. cm ^workspace | ^wk ^move | ^mv [<wkspec>] <new_path>
  6286. Options:
  6287. wkspec Specification of the workspace to move. (Use
  6288. 'cm ^help ^objectspec' to learn more about specs.)
  6289. new_path Workspace will be moved to here.
  6290. == CMD_HELP_WORKSPACE_MOVE ==
  6291. Remarks:
  6292. This command allows users to move a workspace to another location on disk.
  6293. Examples:
  6294. cm ^workspace ^move myWorkspace \new\workspaceDirectory
  6295. (Moves 'myWorkspace' to the specified location.)
  6296. cm ^wk ^mv c:\users\maria\wkspaces\newlocation
  6297. (Moves the current workspace to the new location.)
  6298. == CMD_DESCRIPTION_WORKSPACE_RENAME ==
  6299. Renames a workspace.
  6300. == CMD_USAGE_WORKSPACE_RENAME ==
  6301. Usage:
  6302. cm ^workspace | ^wk ^rename [<wk_name>] <new_name>
  6303. wk_name Workspace to rename.
  6304. new_name New name for the workspace.
  6305. == CMD_HELP_WORKSPACE_RENAME ==
  6306. Remarks:
  6307. This command renames a workspace.
  6308. If no workspace name is supplied, the current workspace will be used.
  6309. Examples:
  6310. cm ^workspace ^rename mywk1 wk2
  6311. (Renames the workspace 'mywk1' to 'wk2'.)
  6312. cm ^wk ^rename newname
  6313. (Renames the current workspace to 'newname'.)
  6314. == CMD_DESCRIPTION_WORKSPACESTATUS ==
  6315. Shows changes in the workspace.
  6316. == CMD_USAGE_WORKSPACESTATUS ==
  6317. Usage:
  6318. cm ^status [<wk_path>] [--^changelist[=<name>] | --^changelists] [--^cutignored]
  6319. [ --^header] [ --^noheader] [ --^nomergesinfo] [ --^head]
  6320. [--^short] [--^symlink] [ --^dirwithchanges] [--^xml[=<output_file>]]
  6321. [--^encoding=<name>] [ --^wrp | --^wkrootrelativepaths]
  6322. [--^fullpaths | --^fp] [<legacy_options>] [<search_types>[ ...]]
  6323. [--^pretty]
  6324. [--^machinereadable [--^startlineseparator=sep]
  6325. [--^endlineseparator=sep] [--^fieldseparator=sep]]
  6326. Options:
  6327. wk_path Path of the workspace where the search will be
  6328. performed.
  6329. --^changelist Shows changes in the selected changelist.
  6330. --^changelists Shows changes grouped in client changelists.
  6331. --^cutignored Skips the contents of ignored directories.
  6332. Requires the '--^ignored' search type. See the Search
  6333. types section for more information.
  6334. --^header Only prints the workspace status.
  6335. --^noheader Only prints the modified item search result.
  6336. --^nomergesinfo Doesn't print the merge info for changes.
  6337. --^head Prints the status of the last changeset on the branch.
  6338. --^short Lists only paths that contains changes.
  6339. --^symlink Applies the operation to the symlink and not to the
  6340. target.
  6341. --^dirwithchanges Shows directories that contain changes inside them
  6342. (added, moved, removed items inside).
  6343. --^xml Prints the output in XML format to the standard output.
  6344. It is possible to specify an output file.
  6345. --^pretty Prints workspace changes in a nice table format.
  6346. --^encoding Used with the --^xml option, specifies the encoding to
  6347. use in the XML output, i.e.: utf-8.
  6348. See the MSDN documentation at
  6349. http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx
  6350. to get the table of supported encodings and its format,
  6351. (at the end of the page, in the "Name" column).
  6352. --^wrp Print workspace root relative paths instead of
  6353. current directory relative paths.
  6354. --^fullpaths, --^fp Force printing absolute paths, overriding any other
  6355. path printing setting.
  6356. --^machinereadable Outputs the result in an easy-to-parse format.
  6357. --^startlineseparator Used with the '--^machinereadable' flag,
  6358. specifies how the lines should start.
  6359. --^endlineseparator Used with the '--^machinereadable' flag,
  6360. specifies how the lines should end.
  6361. --^fieldseparator Used with the '--^machinereadable' flag,
  6362. specifies how the fields should be separated.
  6363. Legacy options:
  6364. --^cset Prints the workspace status in the legacy format.
  6365. --^compact Prints the workspace status and changelists in the
  6366. legacy format.
  6367. --^noheaders When used in conjunction with the '--^compact' flag, the
  6368. changelist headers will not be printed. (Does not apply
  6369. to the new changelists format.)
  6370. Search types:
  6371. --^added Prints added items.
  6372. --^checkout Prints checkedout items.
  6373. --^changed Prints changed items.
  6374. --^copied Prints copied items.
  6375. --^replaced Prints replaced items.
  6376. --^deleted Prints deleted items.
  6377. --^localdeleted Prints locally deleted items.
  6378. --^moved Prints moved items.
  6379. --^localmoved Prints locally moved items.
  6380. --^percentofsimilarity=<value> Percent of similarity between two files in
  6381. order to consider them the same item. Used
  6382. in the locally moved search. Its default
  6383. value is 20%.
  6384. --^txtsameext Only those text files that have the same
  6385. extension will be taken into account by the
  6386. similarity content matching process during
  6387. the moved items search. By default, any
  6388. text file will be processed.
  6389. --^binanyext Any binary file will be taken into account
  6390. by the similarity content matching process
  6391. during the moved items search. By default,
  6392. only those binary files that have the same
  6393. extension will be processed.
  6394. --^private Prints non controlled items.
  6395. --^ignored Prints ignored items.
  6396. --^hiddenchanged Prints hidden changed items. (Includes
  6397. '--^changed')
  6398. --^cloaked Prints cloaked items.
  6399. --^controlledchanged This flag substitutes the following options:
  6400. '--^added', '--^checkout', '--^copied',
  6401. '--^replaced', '--^deleted', '--^moved'.
  6402. --^all This flag replaces the following parameters:
  6403. '--^controlledchanged', '--^changed',
  6404. '--^localdeleted', '--^localmoved', '--^private'.
  6405. == CMD_HELP_WORKSPACESTATUS ==
  6406. Remarks:
  6407. The '^status' command prints the loaded changeset on a workspace and gets
  6408. the changed elements inside the workspace.
  6409. This command can be used to show the pending changes in a workspace; the
  6410. type of changes that can be searched can be modified by using the command
  6411. parameters. By default, all changes are displayed, be they controlled
  6412. or local.
  6413. The percent of similarity parameter '--^percentofsimilarity' (-^p) is used
  6414. by the locally moved search to decide if two elements are the same item.
  6415. The default value is 20% but it can be adjusted.
  6416. It is possible to show workspace changes grouped by client changelists.
  6417. The '^default' changelist includes the changes that are not included in
  6418. other changelists. That being said, the changes the default changelist
  6419. will show depends on the search types flags specified.
  6420. Showing changes grouped by changelists requires showing controlled
  6421. changes too (items with status equal to '^added', '^checkout', '^copied',
  6422. '^replaced', '^deleted', or '^moved'). So, the '--^controlledchanged' option
  6423. will be automatically enabled when changelists are shown.
  6424. The default encoding for XML output is utf-8.
  6425. By default, this command will print current directory relative paths,
  6426. unless the '--^machinereadable' or '--^short' flags are specified. If
  6427. any of them are specified, the command will print absolute paths.
  6428. If '--^xml' flag is specified, workspace root relative paths will
  6429. be printed (unless the '--^fp' flag is also specified, printing
  6430. absolute paths instead).
  6431. Examples:
  6432. cm ^status
  6433. (Prints the working changeset and also all item types changed in the
  6434. workspace, except the ignored ones.)
  6435. cm ^status --^controlledchanged
  6436. (Prints the working changeset and also the items that are checkedout, added,
  6437. copied, replaced, deleted, and moved.)
  6438. cm ^status --^added
  6439. (Prints only the working changeset and the added items inside the workspace.)
  6440. cm ^status c:\workspaceLocation\code\client --^added
  6441. (Prints the working changeset and the added items under the specified path
  6442. recursively.)
  6443. cm ^status --^changelists
  6444. cm ^status --^changelist
  6445. (Shows all the workspace changes grouped by client changelists.)
  6446. cm ^status --^changelist=pending_to_review
  6447. (Shows the changes on the changelist named 'pending_to_review'.)
  6448. cm ^status --^changelist=default --^private
  6449. (Shows the changes in the 'default' changelist, showing private items, along
  6450. with items with controlled changes, if any.)
  6451. cm ^status --^short --^changelist=pending_to_review | cm ^checkin -
  6452. (Checkins the changes in the changelist 'pending_to_review'.)
  6453. cm ^status C:\workspaceLocation --^xml=output.xml
  6454. (Gets the status information in XML format and using utf-8 in the file
  6455. output.xml.)
  6456. cm ^status --^ignored
  6457. (Shows all ignored items.)
  6458. Output:
  6459. /main@myrepo@local (^cs:2 - ^head)
  6460. ^Added
  6461. Status Size Last Modified Path
  6462. ^Ignored 0 bytes 19 seconds ago out\app.exe
  6463. ^Ignored 48 seconds ago src
  6464. ^Ignored 0 bytes 48 seconds ago src\version.c
  6465. cm ^status --^ignored --^cutignored
  6466. (Shows ignored files whose parent directory is not ignored and ignored
  6467. directories but not their contents.)
  6468. Output:
  6469. /main@myrepo@local (^cs:2 - ^head)
  6470. ^Added
  6471. Status Size Last Modified Path
  6472. ^Ignored 0 bytes 19 seconds ago out\app.exe
  6473. ^Ignored 48 seconds ago src
  6474. == CMD_DESCRIPTION_XLINK ==
  6475. Creates, edits, or displays details of an Xlink.
  6476. == CMD_USAGE_XLINK ==
  6477. Usage:
  6478. cm ^xlink [-^w] [-^rs] <xlink_path> / (<csetspec> | <lbspec> | <brspec)>
  6479. [<expansion_rules>[ ...]]
  6480. (Creates an Xlink.)
  6481. cm ^xlink [-^rs] <xlink_path> /<relative_path> (<csetspec> | <lbspec> | <brspec>)
  6482. [<expansion_rules>[ ...]]
  6483. (Creates a readonly partial Xlink pointing to /<relative_path> instead of
  6484. the default root / .)
  6485. cm ^xlink -^e <xlink_path> (<csetspec> | <lbspec> | <brspec>)
  6486. (Edits an Xlink to change the target specification.)
  6487. cm ^xlink -^s|--^show <xlink_path>
  6488. (Shows the Xlink information including the expansion rules.)
  6489. cm ^xlink -^ar|--^addrules <xlink_path> <expansion_rules>[ ...]
  6490. (Adds the given expansion rules to the Xlink).
  6491. cm ^xlink -^dr|--^deleterules <xlink_path> <expansion_rules>[ ...]
  6492. (Removes the given expansion rules from the Xlink).
  6493. xlink_path This is the directory in the current workspace where
  6494. the linked repository will be mounted (when creating an
  6495. Xlink) or is mounted (when editing an Xlink).
  6496. csetspec The full target changeset specification in the remote
  6497. repository.
  6498. This determines what version and branch is loaded in the
  6499. workspace for the linked repository.
  6500. (Use 'cm ^help ^objectspec' to learn more about changeset
  6501. specs.)
  6502. lbspec The full label specification in the remote repository.
  6503. (Use 'cm ^help ^objectspec' to learn more about label
  6504. specs.)
  6505. brspec The full branch specification in the remote repository.
  6506. This uses the current changeset where the specified
  6507. branch is pointing to. (Use 'cm ^help ^objectspec' to
  6508. learn more about branch specs.)
  6509. -^e Edits an existing Xlink to change the target changeset
  6510. specification.
  6511. -^s | --^show Shows information about the selected Xlink.
  6512. -^ar | --^addrules Adds one or more expansion rules to the selected Xlink.
  6513. -^dr | --^deleterules Deletes one or more expansion rules from the selected
  6514. Xlink.
  6515. expansion_rules To specify one or more expansion rule. Each expansion
  6516. rule is a pair branch-target branch:
  6517. ^br:/main/fix-^br:/main/develop/fix
  6518. Options:
  6519. -^w Indicates that the Xlink is writable. This means that
  6520. the contents of the target repository can be modified
  6521. through branch autoexpansion.
  6522. -^rs Relative server. This option allows creating a relative
  6523. Xlink that is independent of the repository server. This
  6524. way, Xlinks created in replicated repositories in
  6525. different servers will be automatically identified.
  6526. == CMD_HELP_XLINK ==
  6527. Remarks:
  6528. This command creates an Xlink to a given changeset. By default, a read-only
  6529. Xlink is created. This means that the contents loaded in the workspace
  6530. inside the Xlink cannot be modified. To be able to make changes in the
  6531. Xlinked content, create a writable Xlink instead (using the '-^w' option).
  6532. It is possible to use a simplified syntax of the command when editing the
  6533. target changeset of an Xlink. This way, the only required parameter is the
  6534. new target changeset. The rest of parameters of the Xlink will not be
  6535. modified.
  6536. Branch auto-expansion:
  6537. When a change is made in any writable-xlinked repositories ('-^w' option), a
  6538. new branch needs to be created in the target repository. The name of the
  6539. new branch is based on the checkout branch defined in the top-level
  6540. repository. To determine the name of the branch to use, these rules apply:
  6541. 1) A check is made to see if a branch with the same full name exists
  6542. in the target repository:
  6543. - If it exists, this is used as the checkout branch.
  6544. - If it does not exist, the branch name is built this way:
  6545. - Name of the branch of the target Xlinked changeset + short name of
  6546. the checkout branch (last part).
  6547. - If this branch exists, it is used as the checkout branch.
  6548. - Otherwise, the branch is created and the branch base is set to the
  6549. Xlinked changeset.
  6550. 2) A new version of the Xlink is created in the branch on the parent
  6551. repository pointing to the new changeset in the Xlinked repository.
  6552. Finally, the complete Xlink structure is kept up to date with the latest
  6553. changes in the right versions.
  6554. Examples:
  6555. cm ^xlink code\firstrepo / 1@first@localhost:8084
  6556. (Creates an Xlink in folder 'firstrepo' in the current workspace where the
  6557. changeset '1' in the repository 'first' will be mounted.)
  6558. cm ^xlink opengl\include /includes/opengl 1627@includes@localhost:8087
  6559. (Creates a readonly partial Xlink in directory 'opengl\include' in the
  6560. current workspace where the path '/includes/opengl' in changeset '1627' in
  6561. the repository 'includes' will be mounted as root. It means that whatever
  6562. is inside '/includes/opengl' will be mounted in 'opengl\include' while the
  6563. rest of the repository will be ignored.)
  6564. cm ^xlink -^w -^rs code\secondrepo / ^lb:LB001@second@localhost:8084
  6565. (Creates a writable and relative Xlink in folder 'secondrepo' in the
  6566. current workspace where the label 'LB001' in the repository 'second' will
  6567. be mounted.)
  6568. cm ^xlink code\thirdrepo / 3@third@localhost:8087 ^br:/main-^br:/main/scm003
  6569. (Creates an Xlink in folder 'thirdrepo' in the current workspace where the
  6570. changeset '3' in the repository 'third' will be mounted.)
  6571. cm ^xlink -^e code\secondrepo ^br:/main/task1234@second@localhost:8084
  6572. (Edits the Xlink 'code\secondrepo' to change the target repository by
  6573. linking the branch 'main/task1234' in the repository 'second'.)
  6574. cm ^xlink --^show code\thirdrepo
  6575. (Shows information of the Xlink 'code\thirdrepo' including its expansion
  6576. rules if exist).
  6577. cm ^xlink -^ar code\secondrepo ^br:/main-^br:/main/develop ^br:/main/fix-^br:/main/develop/fix
  6578. (Adds two expansion rules to the xlink 'code\secondrepo'.)
  6579. cm ^xlink -^dr code\secondrepo ^br:/main/fix-^br:/main/develop/fix
  6580. (Deletes the expansion rule from the xlink 'code\secondrepo').
  6581. == CMD_USAGE_AUTOCOMPLETE ==
  6582. Usage:
  6583. cm ^autocomplete ^install
  6584. (Installs 'cm' command completion in the shell.)
  6585. cm ^autocomplete ^uninstall
  6586. (Uninstalls 'cm' command completion from the shell.)
  6587. cm ^autocomplete --^line <shell_line> --^position <cursor_position>
  6588. (Returns autocomplete suggestions for 'shell_line' to be inserted at
  6589. 'cursor_position'. This command is not intended to be used by the final
  6590. user, but it is documented in case you want to extend autocompletion
  6591. support for your shell of choice.)
  6592. shell_line The line the user has written into the shell when the
  6593. autocompletion was requested.
  6594. In Bash, it is at the COMP_LINE environment variable.
  6595. In PowerShell, it is at the $wordToComplete variable.
  6596. cursor_position The position of the cursor when the autocompletion was
  6597. requested.
  6598. In Bash, it is at the COMP_POINT environment variable.
  6599. In PowerShell, it is at the $cursorPosition variable.
  6600. == CMD_DESCRIPTION_API ==
  6601. Starts a local HTTP server that listens for REST API requests.
  6602. == CMD_USAGE_API ==
  6603. Usage:
  6604. cm ^api [(-^p|--^port)=<portnumber>] [(-^r|--^remote)]
  6605. Options:
  6606. -^p | --^port Tells the server to listen on port <portnumber>
  6607. instead of 9090.
  6608. -^r | --^remote Allows incoming remote connections. This means
  6609. connections that come from other hosts instead of the
  6610. local one.
  6611. == CMD_HELP_API ==
  6612. Remarks:
  6613. The cm ^api command allows programmers to perform Plastic client operations
  6614. in their machines.
  6615. Read the Plastic SCM API Guide for more information:
  6616. https://www.plasticscm.com/documentation/restapi/plastic-scm-version-control-rest-api-guide
  6617. By default, the API listens for local connections only, on port 9090.
  6618. Press the Enter key to stop the server.
  6619. Examples:
  6620. cm ^api
  6621. (Starts the API listening on port 9090, local connections only.)
  6622. cm ^api -^r
  6623. (Starts the API listening on port 9090, allowing any incoming connection.)
  6624. cm ^api --^port=15000 -^r
  6625. (Starts the API listening on port 15000, allowing any incoming connection.)
  6626. == CMD_DESCRIPTION_CONFIGURECLIENT ==
  6627. Configures the Plastic SCM client for the current machine user to work with a default server.
  6628. == CMD_USAGE_CONFIGURECLIENT ==
  6629. Usage:
  6630. cm ^configure [--^language=<language> --^workingmode=<mode> [AuthParameters]
  6631. --^server=<server> [--^port=<port>]] [--^clientconf=<clientconfpath>]
  6632. --^language Available languages:
  6633. en (English)
  6634. es (Spanish)
  6635. --^workingmode Available users/security working modes:
  6636. NameWorkingMode (Name)
  6637. NameIDWorkingMode (Name + ID)
  6638. LDAPWorkingMode (LDAP)
  6639. ADWorkingMode (Active Directory)
  6640. UPWorkingMode (User and password)
  6641. SSOWorkingMode (Single Sign On)
  6642. AuthParameters Auth parameters (only for ^LDAPWorkingMode and ^UPWorkingMode):
  6643. --^user=<user>
  6644. --^password=<password>
  6645. Single Sign On parameters (only for ^SSOWorkingMode):
  6646. --^user=<user>
  6647. --^token=<token>
  6648. --^server Plastic SCM server IP / address
  6649. --^port Plastic SCM server port
  6650. (port optional for Cloud servers)
  6651. --^clientconf File path used to create the configuration file (optional)
  6652. Argument can be a full path, a filename or a directory.
  6653. If this parameter is not specified, the default directory for
  6654. 'client.conf' file would be:
  6655. * '%LocalAppData%\plastic4' on Windows
  6656. * '$HOME/.plastic4' on linux/macOS
  6657. Examples:
  6658. --^clientconf=c:/path/to/myclient.conf
  6659. (Specified path will be used to create the client configuration file)
  6660. --^clientconf=myclient.conf
  6661. (File myclient.conf inside default config directory will be used)
  6662. --^clientconf=c:/exisitingDirectory
  6663. (Default filename, client.conf, in specified directory will be used)
  6664. == CMD_HELP_CONFIGURECLIENT ==
  6665. Remarks:
  6666. The cm ^configure command cannot be used on Cloud Edition or DVCS Edition of Plastic SCM.
  6667. Use 'plastic --configure' instead.
  6668. Examples:
  6669. cm ^configure
  6670. (runs the interactive Plastic SCM client configuration command)
  6671. cm ^configure --^language=^en --^workingmode=^LDAPWorkingMode --^user=^jack --^password=^01234 \
  6672. --^server=^plastic.mymachine.com --^port=^8084
  6673. (configures the Plastic SCM client with the specified parameters and creates the 'client.conf'
  6674. configuration file in the default directory).
  6675. cm ^configure --^language=^en --^workingmode=^NameWorkingMode --^server=^plastic.mymachine.com \
  6676. --^port=^8084 --^clientconf=^clientconf_exp.conf
  6677. (configures the Plastic SCM client with the specified parameters and creates the 'client.conf'
  6678. configuration file in the specified path).